Multi Theft Auto: Wiki - User contributions [en]

SetElementBoneRotation

2021-01-21T21:32:00Z

Saml1er: Improve example

__NOTOC__
{{Client function}}
{{New feature/item|3.0160|1.5.8|20704|This function sets the rotation of a specific bone relative to the element. Currently the following element types are accepted:
* [[Element/Player|Player]]
* [[Element/Ped|Ped]]
}}
{{Tip|If you want to attach an element to a bone, see [[attachElementToBone]]}}

==Syntax==
<syntaxhighlight lang="lua">
bool setElementBoneRotation ( element theElement, int bone, float yaw, float pitch, float roll )
</syntaxhighlight>

[[Image:The-yaw-pitch-and-roll-angles-in-the-human-head-motion-11.png|thumb|Rotation axes]]

===Required Arguments===
*'''theElement:''' the element to set the bone rotation on.
*'''bone:''' the ID of the bone to set the rotation of. See [[Bone IDs]]
*'''yaw:''' the 'yaw' rotation value.
*'''pitch:''' the 'pitch' rotation value.
*'''roll:''' the 'roll' rotation value.

===Returns===
Returns ''true'' if the function was successful, ''false'' otherwise.

'''Note:''' [[updateElementRpHAnim]] must be called after this function to apply bone rotation.

==Example==
This example shows how you can turn a local player into a so-called 'Helicopter'.
<syntaxhighlight lang="lua">local custom_yaw = 0

setTimer(function()
custom_yaw = custom_yaw + 20
end, 10, 0)

local shoulders = {22, 32}

function changeBoneRotation()
local yaw, pitch, roll = getElementBoneRotation(localPlayer, 2)
setElementBoneRotation(localPlayer, 2, custom_yaw, pitch, roll)
for key, value in pairs(shoulders) do
setElementBoneRotation(localPlayer, value, 0, 0, 0)
end
updateElementRpHAnim(localPlayer)
end
addEventHandler("onClientPedsProcessed", getRootElement(), changeBoneRotation)
</syntaxhighlight>

==See Also==
{{Client_element_functions}}

AttachElementToBone

2020-11-28T02:09:52Z

Saml1er: Make onPedsProcessed function local in code example

{{Useful Function}}
<lowercasetitle/>
__NOTOC__
This function allows you to attach an object, ped, player or vehicle to a ped or player bone for '''ONE FRAME'''. In order to attach an element continuously to a bone, this function should be used in conjunction with [[onClientPedsProcessed]].
The function checks if a player is actually on screen and if he is not, the object gets moved out of the stream distance in order to preserve some performance.
Unlike bone_attach, this function provides perfect accuracy for the attached elements and performs better.

==Syntax==
<syntaxhighlight lang="lua">bool attachElementToBone(element theElement, ped thePed, int boneID, float offsetX, float offsetY, float offsetZ, float rotationOffsetX, float rotationOffsetZ, float rotationOffsetZ)</syntaxhighlight>

===Required arguments===
* '''theElement''': The element which should be attached to the ped/player bone. Should work with any element that is supported by matrix functions.
* '''thePed''': The ped or player which the element should be attached to.
* '''boneID''': The target bone where the element should be attached to.
* '''offsetX''': The X position offset from the bone.
* '''offsetY''': The Y position offset from the bone.
* '''offsetZ''': The Z position offset from the bone.
* '''rotationOffsetX''': The rotation X-axis offset from the bone, in '''radians'''.
* '''rotationOffsetY''': The rotation Y-axis offset from the bone, in '''radians'''.
* '''rotationOffsetZ''': The rotation Z-axis offset from the bone, in '''radians'''.

[[Image:Bones.jpg|thumb|Bone numbers]]

<div style="border: 3px red solid; margin-bottom:3px; padding-left:5px;">
*'''1:''' BONE_PELVIS1
*'''2:''' BONE_PELVIS
*'''3:''' BONE_SPINE1
*'''4:''' BONE_UPPERTORSO
*'''5:''' BONE_NECK
*'''6:''' BONE_HEAD2
*'''7:''' BONE_HEAD1
*'''8:''' BONE_HEAD
*'''21:''' BONE_RIGHTUPPERTORSO
*'''22:''' BONE_RIGHTSHOULDER
*'''23:''' BONE_RIGHTELBOW
*'''24:''' BONE_RIGHTWRIST
*'''25:''' BONE_RIGHTHAND
*'''26:''' BONE_RIGHTTHUMB
*'''31:''' BONE_LEFTUPPERTORSO
*'''32:''' BONE_LEFTSHOULDER
*'''33:''' BONE_LEFTELBOW
*'''34:''' BONE_LEFTWRIST
*'''35:''' BONE_LEFTHAND
*'''36:''' BONE_LEFTTHUMB
*'''41:''' BONE_LEFTHIP
*'''42:''' BONE_LEFTKNEE
*'''43:''' BONE_LEFTANKLE
*'''44:''' BONE_LEFTFOOT
*'''51:''' BONE_RIGHTHIP
*'''52:''' BONE_RIGHTKNEE
*'''53:''' BONE_RIGHTANKLE
*'''54:''' BONE_RIGHTFOOT
</div>

===Return===
Returns true if the object has successfully been attached to the ped/player, returns false if the specified ped/player is not on screen and the object has been moved out of the streaming distance.

==Code==
<syntaxhighlight lang="lua">
function attachElementToBone(element, ped, bone, offX, offY, offZ, offrx, offry, offrz)
if isElementOnScreen(ped) then
local boneMat = getElementBoneMatrix(ped, bone)
local sroll, croll, spitch, cpitch, syaw, cyaw = math.sin(offrz), math.cos(offrz), math.sin(offry), math.cos(offry), math.sin(offrx), math.cos(offrx)
local rotMat = {
{sroll * spitch * syaw + croll * cyaw,
sroll * cpitch,
sroll * spitch * cyaw - croll * syaw},
{croll * spitch * syaw - sroll * cyaw,
croll * cpitch,
croll * spitch * cyaw + sroll * syaw},
{cpitch * syaw,
-spitch,
cpitch * cyaw}
}
local finalMatrix = {
{boneMat[2][1] * rotMat[1][2] + boneMat[1][1] * rotMat[1][1] + rotMat[1][3] * boneMat[3][1],
boneMat[3][2] * rotMat[1][3] + boneMat[1][2] * rotMat[1][1] + boneMat[2][2] * rotMat[1][2],-- right
boneMat[2][3] * rotMat[1][2] + boneMat[3][3] * rotMat[1][3] + rotMat[1][1] * boneMat[1][3],
0},
{rotMat[2][3] * boneMat[3][1] + boneMat[2][1] * rotMat[2][2] + rotMat[2][1] * boneMat[1][1],
boneMat[3][2] * rotMat[2][3] + boneMat[2][2] * rotMat[2][2] + boneMat[1][2] * rotMat[2][1],-- front
rotMat[2][1] * boneMat[1][3] + boneMat[3][3] * rotMat[2][3] + boneMat[2][3] * rotMat[2][2],
0},
{boneMat[2][1] * rotMat[3][2] + rotMat[3][3] * boneMat[3][1] + rotMat[3][1] * boneMat[1][1],
boneMat[3][2] * rotMat[3][3] + boneMat[2][2] * rotMat[3][2] + rotMat[3][1] * boneMat[1][2],-- up
rotMat[3][1] * boneMat[1][3] + boneMat[3][3] * rotMat[3][3] + boneMat[2][3] * rotMat[3][2],
0},
{offX * boneMat[1][1] + offY * boneMat[2][1] + offZ * boneMat[3][1] + boneMat[4][1],
offX * boneMat[1][2] + offY * boneMat[2][2] + offZ * boneMat[3][2] + boneMat[4][2],-- pos
offX * boneMat[1][3] + offY * boneMat[2][3] + offZ * boneMat[3][3] + boneMat[4][3],
1}
}
setElementMatrix(element, finalMatrix)
return true
else
setElementPosition(element, 0, 0, -1000)
return false
end
end
</syntaxhighlight>

==Example==
<section name="Client" class="client" show="true">
This example attaches a sniper rifle and a backpack to the local player.
<syntaxhighlight lang="lua">
local theGun = createObject(358, 0, 0, 0)
local thePara = createObject(371, 0, 0, 0)

local function onPedsProcessed()
attachElementToBone(theGun, localPlayer, 24, 0, 0, 0, 0, 0, 0)-- Attach the sniper model to bone #24 of the local player, no offset is needed because the default GTA weapon models fit perfectly fine into bone #24
attachElementToBone(thePara, localPlayer, 3, 0.1, -0.14, 0, math.rad(90), 0, 0)-- Attach parachute to bone #3 of the local player with a small position and rotation offset, so it looks nice
end
addEventHandler("onClientPedsProcessed", root, onPedsProcessed)
</syntaxhighlight>
</section>

==See Also==
{{Useful_Functions}}

Game Processing Order

2020-11-24T17:47:47Z

Saml1er:

[[File:Mta_game_proccess.png|left|caption]]
== Game processing order ==
Here is an overview to show the order in which things get done during an average frame of playing MTA.

The [[onClientPreRender]] event is triggered after GTA updates the world, and is the ideal place to do dxDraws that are in some way attached to world elements.

The [[onClientHUDRender]] event is triggered before GTA renders the in-game HUD, so it the best place to apply any full screen effects that you want 'behind' the HUD.

The [[onClientPedsProcessed]] event is triggered after GTA updates bone transformations for all peds. This event can be used for updating bones.

File:Game process order.png

2020-11-24T01:22:47Z

Saml1er: Saml1er uploaded a new version of File:Game process order.png

Game Processing Order

2020-11-24T01:20:26Z

Saml1er: Add onClientPedsProcessed

[[File:Game_process_order.png|left|caption]]
== Game processing order ==
Here is an overview to show the order in which things get done during an average frame of playing MTA.

The [[onClientPreRender]] event is triggered after GTA updates the world, and is the ideal place to do dxDraws that are in some way attached to world elements.

The [[onClientHUDRender]] event is triggered before GTA renders the in-game HUD, so it the best place to apply any full screen effects that you want 'behind' the HUD.

The [[onClientPedsProcessed]] event is triggered after GTA updates bone transformations for all peds. This event can be used for updating bones.

File:Game process order.png

2020-11-24T01:18:27Z

Saml1er:

Template:Useful Functions

2020-11-24T00:30:27Z

Saml1er: Add attachElementToBone

__NOTOC__
=== Table functions ===
*[[isValueInTable]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns true if the value exists in the table, false if the value does not exist in the table.</span>
*[[setTableToSql]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to save the table in the database (sql).</span>
*[[getTableFromSql]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This functionality is used to obtain saved tables using the function ([https://wiki.multitheftauto.com/wiki/SetTableToSql SetTableToSql ]).</span>
*[[rangeToTable]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a string range to a table containing number values.</span>
*[[setTableProtected]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function protects a table and makes it read-only.</span>
*[[Sort_Functions]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» These functions are able to sort your tables by a key.</span>
*[[table.compare]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether two given tables are equal.</span>
*[[table.copy]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function copies a whole table and all the tables in that table.</span>
*[[table.empty]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether a table is empty.</span>
*[[table.map]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function goes through a table and replaces every field with the return of the passed function, where the field's value is passed as first argument and optionally more arguments.</span>
*[[table.merge]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function merges two or more tables together.</span>
*[[table.random]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function retrieves a random value from a table.</span>
*[[table.removeValue]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function removes a specified value from a table.</span>
*[[table.size]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the absolute size of a table.</span>
*[[table.getRandomRows]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns random rows from table.</span>
*[[table.element]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a new table with only userdata content.</span>
*[[pairsByKeys]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function sort pairs table.</span>

=== ACL functions ===
*[[aclGroupClone]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function clone a group to another group with/without ACLs and/or objects.</span>
*[[getPlayersInACLGroup]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns all players in an ACL group.</span>
*[[getPlayerAcls]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all ACL groups on a player.</span>
*[[isPlayerInACL]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a player element is in an ACL group.</span>
*[[renameAclGroup]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gives an existing ACL group a new name.</span>
*[[getAccountsRanks]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to detect the account name groups and put them in the chat.</span>

=== Account functions ===
*[[getPlayerFromAccountName]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to obtain a player by the name of his account.</span>

=== Camera functions ===
*[[smoothMoveCamera]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to create a cinematic camera flight.

=== Cursor functions ===
*[[getCursorMovedOn]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks in which way the cursor is currently moving.</span>

=== Drawing functions ===
*[[dxDrawAnimWindow]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws an animated 2D window on the screen.</span>
*[[dxDrawBorderedRectangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a bordered rectangle.</span>
*[[dxDrawBorderedText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a bordered text.</span>
*[[dxDrawDashedLine]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a line with dashes.</span>
*[[dxDrawRing]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a ring with dx lines.</span>
*[[dxDrawTextOnRectangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Esta funcion crea un rectangle con un texto dentro.</span>
*[[dxDrawGifImage]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function simulates the effect of a GIF image by using image sprites in 2D.</span>
*[[dxDrawImage3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a 3D image in GTA world.</span>
*[[dxDrawSprite]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draw a sprite in the 3D world.</span>
*[[dxDrawImageOnElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws an image on any element.</span>
*[[dxDrawLinedRectangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a rectangle outline with dx lines.</span>
*[[dxDrawLoading]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a loading bar on the screen.</span>
*[[dxDrawOctagon3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function creates a 3D Octagon</span>
*[[dxDrawPolygon]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a custom polygon on the screen.</span>
*[[dxDrawRectangle3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a 3D rectangle in GTA world.</span>
*[[dxDrawProgressBar]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function simulates a progress bar drawed using DirectDraw.</span>
*[[dxDrawTextOnElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function draws a text on any element.</span>
*[[dxDrawTriangle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is a function that will create a triangle with dx lines.</span>
*[[dxGetFontSizeFromHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the font size from given height.</span>
*[[dxGetRealFontHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the height of a font.</span>
*[[wordWrap]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function breaks a long string into a table of separate lines limited to a specific length in pixels, for drawing separately.</span>
*[[dxDrawRombo]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function creates a Rhombus.</span>

=== Effects functions ===
*[[attachEffect]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you attach an effect to an element.</span>

=== Element functions ===
*[[getElementSpeed]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the specified element's speed in m/s, km/h or mph.</span>
*[[getElementsInDimension]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of elements that are in the specified dimension.</span>
*[[getElementsWithinMarker]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of elements that are within a marker's collision shape.</span>
*[[getNearestElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the nearest element (of a specific type) to a player.</span>
*[[isElementInPhotograph]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if an element is in the player's camera picture area.</span>
*[[isElementInRange]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to check if an element's range to a main point is within the maximum range.</span>
*[[isElementMoving]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if an element is moving.</span>
*[[isElementWithinAColShape]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if an element is within a collision shape element.</span>
*[[multi_check]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks one element to many, handy and clean.</span>
*[[setElementSpeed]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to set the speed of an element in kph or mph units.</span>
*[[attachElementToBone]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to attach an element to ped bone accurately using new bone functions.</span>

=== Events ===
*[[onVehicleWeaponFire]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This code implements an event that is triggered when a player in a vehicle fires a vehicle's weapon.</span>

=== Input functions ===
*[[bindControlKeys]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to bind each key bound to a control individually. Doing this bypasses a little MTA restriction.</span>
*[[getBoundControls]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of control names that are bound to the specified key.</span>
*[[unbindControlKeys]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to unbind each key bound to a control individually. Use this function with [[bindControlKeys]].</span>
*[[getClipboard]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This event returns the contents of the clipboard by pressing ctrl + v / ctrl + V. Event triggered ONLY if cursor is showing.</span>

=== Data functions ===
*[[byte2human]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts an integer (number of bytes) into a human-readable unit.</span>
*[[capitalize]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function capitalizes a given string.</span>
*[[convertServerTickToTimeStamp]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts server ticks to a unix timestamp.</span>
*[[convertTextToSpeech]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts the provided text to a speech in the provided language which players can hear.</span>
*[[findRotation]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function takes two points and returns the direction from point A to point B.</span>
*[[findRotation3D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function takes two sets of XYZ coordinates. It returns the 3D direction from point A to point B.</span>
*[[formatDate]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function formats a date on the basis of a format string and returns it.</span>
*[[formatNumber]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function formats large numbers by adding commas.</span>
*[[generateString]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function generates a random string with any characters.</span>
*[[generateRandomASCIIString]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a random string which uses ASCII characters. </span>
*[[getDistance]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Returns the distance between two elements.</span>
*[[getAge]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function calculates the age of a given birthday.</span>
*[[getDistanceBetweenPointAndSegment2D]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function takes point coordinates and line (a segment) starting and ending coordinates. It returns the shortest distance between the point and the line.</span>
*[[getEasterDate]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns easter date monthday and month for a given year.</span>
*[[getKeyFromValueInTable]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the key of the specified value in a table.</span>
*[[getOffsetFromXYZ]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to take an entity and a position and calculate the relative offset between them accounting for rotations.</span>
*[[getPointFromDistanceRotation]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function finds a point based on a starting point, direction and distance.</span>
*[[getRealMonthH]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function convert english months to arabic months</span>
*[[getRealMonthM]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gives you the real months name</span>
*[[getRGColorFromPercentage]] <span style="color:gray; font-family:'Georgia', sans-serif; font-size:smaller;">»This function returns two integers representing red and green colors according to the specified percentage.</span>
*[[getScreenRotationFromWorldPosition]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a screen relative rotation to a world position.</span>
*[[getTimestamp]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the UNIX timestamp of a specified date and time.</span>
*[[isLeapYear]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a boolean representing if a given year is a leap year.</span>
*[[isValidMail]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether a provided e-mail string is valid.</span>
*[[removeHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is used to remove hexadecimal numbers (colors, for example) from strings.
*[[RGBToHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a string representing the color in hexadecimal.</span>
*[[secondsToTimeDesc]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a plain seconds-integer into a user-friendly time description.</span>
*[[string.count]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function counts the amount of occurences of a string in a string.</span>
*[[string.insert]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function inserts a string within another string at a given position.</span>
*[[string.explode]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function splits a string at a given separator pattern and returns a table with the pieces.</span>
*[[switch]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows the value of a variable or expression to control the flow of program execution via a multiway branch.</span>
*[[toHex]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a decimal number to a hexadecimal number, as a fix to be used client-side.</span>
*[[var dump]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function outputs information about one or more variables using outputConsole.</span>
*[[wavelengthToRGBA]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts a physical wavelength of light to a RGBA color.</span>
*[[getDistanceBetweenElements]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Esta funcion sirve para obtener la distancia entre dos elementos.</span>
*[[getFreeDimension]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function get free dimension.</span>

=== GUI functions ===
*[[centerWindow]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function centers a CEGUI window element responsively in any resolution.</span>
*[[guiMoveElement]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function moves guiElement by/like using moveObject.</span>
*[[isMouseOnGUICloseButton]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to check whether the mouse cursor/pointer is within a gui-window's native close button.</span>
*[[guiSetStaticImageMovable]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to move a static image like a gui window.</span>
=====Comboboxes=====
*[[guiComboBoxAdjustHeight]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function adjusts a CEGUI combobox element to have the correct height.</span>

=====Gridlists=====
*[[guiGridListAddPlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function add all online players to a grid list.</span>
*[[guiGridListGetColumnIDFromTitle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a gridlist's column ID from the column title.</span>
*[[guiGridListSetColumnNonSortable]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function makes a gridlist column become non-sortable.</span>
*[[guiGridListSetColumnsFixedWidth]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function makes a gridlist have all its columns fixed width.</span>
*[[guiGridListGetSelectedText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a string containing the inner text of a selected gridlist item.</span>
*[[getGridListRowIndexFromText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the GridList row index from the specified text.</span>
*[[isTextInGridList]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if some text exist or not in the GridList.</span>
*[[convertGridListToText]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function converts grid list contents to text.</span>

=====Labels=====
*[[guiLabelAddEffect]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function add an effects to the gui-label like (shadow, outline).</span>

=== Marker functions ===
*[[createMarkerAttachedTo]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function creates a marker that is attached to an element.</span>

=== Math functions ===
*[[mathNumber]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function is a workaround for the client-side floating-point precision of 24-bits.</span>
*[[math.hypot]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the Hypotenuse of the triangle given by sides x and y.</span>
*[[math.percent]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a percentage from two number values.</span>
*[[math.round]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Rounds a number whereas the number of decimals to keep and the method may be set.</span>
*[[reMap]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Re-maps a number from one range to another.</span>
*[[math.isPointInPolygon]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Check if point is inside polygon or not.</span>
*[[math.polygonArea]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Compute area of any polygon.</span>
*[[math.randomDiff]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Generates a pseudo-random integer that's always different from the last random number generated.</span>

=== Map functions ===
*[[assignLod]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function lets you conveniently generate and apply a LOD model to a mapping object</span>

=== Ped functions ===
*[[getAlivePlayers (Client)|getAlivePlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the alive players client-side.</span>
*[[getAlivePlayersInTeam]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the alive players in a team.</span>
*[[getPlayersInVehicles]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the players insides vehicles from a specified dimension.</span>
*[[getGuestPlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a players not login or players Guest .</span>
*[[getOnlineAdmins]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all logged-in administrators.</span>
*[[getPedEyesPosition]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to get peds eyes position.</span>
*[[getPedMaxHealth]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a pedestrians's maximum health by converting it from their maximum health stat.</span>
*[[getPedMaxOxygenLevel]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a ped's maximum oxygen level by converting it from their maximum underwater stamina stat.</span>
*[[getPedWeaponSkill]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a ped's corresponding weapon skill level name.</span>
*[[getPlayerFromNamePart]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a player from partial name.</span>
*[[getPlayerFromSerial]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a player from their serial.</span>
*[[getPlayersByData]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of players that have the specified data name.</span>
*[[getPlayersInPhotograph]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all players in photograph.</span>
*[[isPedAiming]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a pedestrian is aiming their weapon.</span>
*[[isPedAimingNearPed]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This is similar to isPedAiming but uses a colshape to be more precise.</span>
*[[isPedDrivingVehicle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a specified pedestrian is driving a vehicle.</span>
*[[isPlayerInTeam]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a player is in a specified team.</span>

=== Player functions ===
*[[countPlayersInRange]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the number of players that are within a certain range of the specified coordinates.</span>
*[[isPlayerHitByVehicle]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function cancels event when a element is hit by a vehicle.</span>
*[[warpToPlayer]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function make player warp to another player.</span>
*[[getPlayersInRange]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function make a table of players within certain range.</span>

=== Resource functions ===
*[[getResourceScripts]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the resource scripts.</span>
*[[getResourceSize]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the size of a specified resource in kB(kilobyte)</span>
*[[getResourceSettings]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of the resource settings.</span>
*[[refreshResource]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function refreshes your resource if you changed any of the files
*[[setResourcePriority]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function set resource download priority group.</span>
*[[getFilesInResourceFolder]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a list of files that are inside a folder of a resource.</span>

=== Sound functions ===
*[[isSoundFinished]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a sound element has finished.</span>
*[[stopSoundSlowly]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function stop your sound element slowly.</span>

=== Browser functions ===
*[[playVideo]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function plays a video on the screen.</span>

=== Team functions ===
*[[getTeamFromColor]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a team element by the specified color.</span>
*[[getTeamWithFewestPlayers]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a team element with least players of all the specified teams.</span>

=== Vehicle functions ===
*[[findEmptyCarSeat]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function finds you the first empty seat in a vehicle.</span>
*[[getNearestVehicle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets the nearest vehicle to the specified player in a specified distance.</span>
*[[getRandomVehicle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a random vehicle.</span>
*[[getValidVehicleModels]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of all valid vehicle models.</span>
*[[getVehiclesCountByType]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the amount of vehicles by the given type as an integer value.</span>
*[[isVehicleEmpty]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether a vehicle is empty.</span>
*[[isVehicleOccupied]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a specified vehicle is occupied.</span>
*[[isVehicleOnRoof]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks whether vehicle is on roof.</span>
*[[isVehicleReversing]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a specified vehicle is moving backwards.</span>
*[[isVehicleUpgraded]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks is vehicle upgraded by upgrade ID.</span>
*[[setVehicleGravityPoint]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified.</span>
*[[getVehicleTurnVelocityCenterOfMass]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function gets a vehicle's turn velocity relative to the vehicle's center or mass.</span>
*[[setVehicleTurnVelocityCenterOfMass]]<span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function sets a vehicle's turn velocity relative to the vehicle's center or mass.</span>

=== Weapon functions ===
*[[getJetpackWeaponsEnabled]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns a table of enabled weapons usable on a jetpack.</span>
*[[getPreviousAndNextWeapon]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the next weapon and previous.</span>

=== XML functions ===
*[[getXMLNodes]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns all children of a XML node.</span>

=== Utility ===
*[[animate]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to use interpolateBetween without render event and easily used.</span>
*[[callClientFunction]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to call any client-side function from the server's side.</span>
*[[callServerFunction]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to call any server-side function from the client's side.</span>
*[[check]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if its arguments are of the right type and calls the error-function if one is not.</span>
*[[checkPassiveTimer]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to use passive timers in your conditions. For example you want to prevent players repeatedly using a command.</span>
*[[coroutine.resume]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function applies a fix for hidden coroutine error messages.</span>
*[[getBanFromName]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This functions returns the ban of the given playername.</span>
*[[getCurrentFPS]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the frames per second at which GTA: SA is running.</span>
*[[IfElse]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns one of two values based on a boolean expression.</span>
*[[isMouseInCircle]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function checks if a cursor position is in circular area or not.</span>
*[[isMouseInPosition]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allows you to check whether the mouse cursor/pointer is within a rectangular position.</span>
*[[isCharInString]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This shared function allows you to check if a char specified is in a string value.</span>
*[[iterElements]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns ''a time-saving'' iterator for your for-loops.</span>
*[[vector3:compare]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This method checks whether two vectors match, with optional precision.</span>
*[[preprocessor]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function allow you to use gcc macros.</span>
*[[PlotTrajectoryAtTime]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» Calculate projectile/water trajectory.</span>
*[[getSkinNameFromID]] <span style="color:gray; font-family:'Georgia',sans-serif; font-size:smaller;">» This function returns the name of the skin from the given id.</span>

<noinclude>[[Category:Useful Functions]]</noinclude>

EngineLoadIFP

2019-12-20T20:09:11Z

Saml1er: Rename customBlockName to custom_block_name in syntax

{{Client function}}
__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]].

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==
<syntaxhighlight lang="lua">
ifp engineLoadIFP ( string ifp_file / string raw_data, string custom_block_name )
</syntaxhighlight>

===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.
*'''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 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}}

==Example==
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.

<syntaxhighlight lang="lua">
--[[
credits to Paul_Cortez for the IFP file.
parkour.ifp has following animations:

BckHndSpingBTuck
BckHndSping
CartWheel
FrntHndSpring
HandPlant
]]

-- you can choose any name you want, do not choose a default GTA:SA block name
local customBlockName = "myNewBlock"

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

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

-- execute the command using /animation <NameOfCustomAnimation>
-- for example, /animation CartWheel
function setanimation( _, animationName )
-- check if IFP file has loaded
if IFP then
-- now play our custom animation
setPedAnimation( localPlayer, customBlockName, animationName )
end
end
addCommandHandler( "animation", setanimation )
</syntaxhighlight>

==See Also==
{{Engine_functions}}

SetPedAnimation

2019-04-23T07:42:14Z

Saml1er: Add restoreTaskOnAnimEnd parameter

__NOTOC__
{{Server client function}}

Sets the current [[Animations|animation]] of a [[player]] or [[ped]]. Not specifying the type of animation will automatically cancel the current one.

==Syntax==
<syntaxhighlight lang="lua">
bool setPedAnimation ( ped thePed [, string block = nil, string anim = nil, int time = -1, bool loop = true, bool updatePosition = true,
bool interruptable = true, bool freezeLastFrame = true, int blendTime = 250, bool restoreTaskOnAnimEnd = false ] )
</syntaxhighlight>
{{OOP||[[ped]]:setAnimation||getPedAnimation}}

===Required Arguments===
*'''thePed:''' the [[player]] or [[ped]] you want to apply an [[Animations|animation]] to.

===Optional Arguments===
{{OptionalArg}}
*'''block:''' the [[Animations|animation]] block's name.
*'''anim:''' the name of the [[Animations|animation]] within the block.
*'''time:''' how long the animation will run for in milliseconds.
*'''loop:''' indicates whether or not the animation will loop.
*'''updatePosition:''' will change the actual coordinates of the ped according to the animation. Use this for e.g. walking animations.
*'''interruptable:''' if set to ''false'' other tasks wont be able to interupt the animation. Setting this to 'false' also gives this function more power to override other animations that are running. For example, squatting after a jump can be terminated.
*'''freezeLastFrame:''' if set to ''true'' after animation the last frame will be frozen, otherwise the animation will end and controls will return.
*'''blendTime:''' how long the animation will mixed with the previous one in milliseconds.
{{New items|3.0157|1.5.7|
*'''restoreTaskOnAnimEnd:''' will restore the task which was playing before calling this function. Useful for restoring the crouch task after animation ends.
|16632}}

===Returns===
Returns ''true'' if succesful, ''false'' otherwise.

==Examples==

<section name="Server" class="server" show="true">
This example creates a ped, rotates him, and makes him walk:
<syntaxhighlight lang="lua">
function makePed()
local thePed = createPed(56, 1, 1, 4, 315)
setPedAnimation(thePed, "ped", "WOMAN_walknorm")
end
addCommandHandler("makemyped", makePed)
</syntaxhighlight>
</section>

<section name="Server" class="server" show="true">
This example makes the player sit down and stand up using the command /sit.
<syntaxhighlight lang="lua">
function toggleSit(thePlayer)
if not getElementData(thePlayer, "sitting") then
setPedAnimation(thePlayer, "ped", "seat_down", -1, false, false, false, false)
setElementData(thePlayer, "sitting", true)
else
-- If you use again this command then your character stand up
setPedAnimation(thePlayer)
removeElementData(thePlayer, "sitting")
end
end
addCommandHandler("sit", toggleSit)
</syntaxhighlight>
</section>

==Issues==
{{Issues|
{{Issue|9522|Setting a [[ped|ped's]] or [[player|player's]] animation whilst occupying a [[givePedJetPack|jetpack]] will remove their jetpack, but not the jetpack sound}}
}}

==See Also==
{{Ped_functions}}
[[ru:setPedAnimation]]
[[HU:setPedAnimation]]

SetPedAnimation

2018-10-07T11:26:22Z

Saml1er: Removed warning

__NOTOC__
{{Server client function}}

Sets the current [[Animations|animation]] of a [[player]] or [[ped]]. Not specifying the type of animation will automatically cancel the current one.

==Syntax==
<syntaxhighlight lang="lua">
bool setPedAnimation ( ped thePed [, string block = nil, string anim = nil, int time = -1, bool loop = true, bool updatePosition = true,
bool interruptable = true, bool freezeLastFrame = true, int blendTime = 250 ] )
</syntaxhighlight>
{{OOP||[[ped]]:setAnimation||getPedAnimation}}

===Required Arguments===
*'''thePed:''' the [[player]] or [[ped]] you want to apply an [[Animations|animation]] to.

===Optional Arguments===
{{OptionalArg}}
*'''block:''' the [[Animations|animation]] block's name.
*'''anim:''' the name of the [[Animations|animation]] within the block.
*'''time:''' how long the animation will run for in milliseconds.
*'''loop:''' indicates whether or not the animation will loop.
*'''updatePosition:''' will change the actual coordinates of the ped according to the animation. Use this for e.g. walking animations.
*'''interruptable:''' if set to ''false'' other tasks wont be able to interupt the animation. Setting this to 'false' also gives this function more power to override other animations that are running. For example, squatting after a jump can be terminated.
*'''freezeLastFrame:''' if set to ''true'' after animation the last frame will be frozen, otherwise the animation will end and controls will return.
*'''blendTime:''' how long the animation will mixed with the previous one in milliseconds.

===Returns===
Returns ''true'' if succesful, ''false'' otherwise.

==Examples==

<section name="Server" class="server" show="true">
This example creates a ped, rotates him, and makes him walk:
<syntaxhighlight lang="lua">
function makePed()
local thePed = createPed(56, 1, 1, 4, 315)
setPedAnimation(thePed, "ped", "WOMAN_walknorm")
end
addCommandHandler("makemyped", makePed)
</syntaxhighlight>
</section>

<section name="Server" class="server" show="true">
This example makes the player sit down and stand up using the command /sit.
<syntaxhighlight lang="lua">
function toggleSit(thePlayer)
if not getElementData(thePlayer, "sitting") then
setPedAnimation(thePlayer, "ped", "seat_down", -1, false, false, false, false)
setElementData(thePlayer, "sitting", true)
else
-- If you use again this command then your character stand up
setPedAnimation(thePlayer)
removeElementData(thePlayer, "sitting")
end
end
addCommandHandler("sit", toggleSit)
</syntaxhighlight>
</section>

==Issues==
{{Issues|
{{Issue|9522|Setting a [[ped|ped's]] or [[player|player's]] animation whilst occupying a [[givePedJetPack|jetpack]] will remove their jetpack, but not the jetpack sound}}
}}

==See Also==
{{Ped_functions}}
[[ru:setPedAnimation]]

EngineReplaceAnimation

2018-10-07T11:24:51Z

Saml1er: Removed warning

__NOTOC__
{{Client function}}
{{New feature/item|3.0156|1.5.5|12195|
This function replaces a specific internal (default) animation with a custom one that has been loaded using [[EngineLoadIFP|engineLoadIFP]] function. This function only affects a specific [[player]] or [[ped]], the [[Animations|internal animation]] is not replaced for everyone, for instance, different players and peds are able to have completely different crouching, walking, and fighting etc., animations running simultaneously at the same time. Also, it's not synchronized, you'll need to execute this function on every client in Lua to synchronize it.

Internal animations replaced using this function can still be played with [[SetPedAnimation|setPedAnimation]]. You can restore replaced animations back with [[EngineRestoreAnimation|engineRestoreAnimation]].

It should be noted that partial animations are not supported, you can still replace them, but they won't work as intended, for example, "FightA_block" animation from "ped" block is a partial animation, you can't replace it properly, only a few animations are partial, rest of them are not, so it shouldn't be a problem.}}

==Syntax==
<syntaxhighlight lang="lua">
bool engineReplaceAnimation ( ped thePed, string InternalBlockName, string InternalAnimName, string CustomBlockName, string CustomAnimName )
</syntaxhighlight>

===Required Arguments===
*'''thePed:''' the [[player]] or [[ped]] you want to replace an animation for.
*'''InternalBlockName:''' the [[Animations|internal block]] name.
*'''InternalAnimName:''' the [[Animations|internal animation]] name inside InternalBlockName.
*'''CustomBlockName:''' the custom block name of the loaded IFP file that you passed to [[EngineLoadIFP|engineLoadIFP]] as second parameter.
*'''CustomAnimName:''' the custom animation name inside the loaded IFP file with CustomBlockName.
===Returns===
Returns ''true'' on success, ''false'' in case of failure.

==Example==
This example loads a custom IFP file ([https://drive.google.com/file/d/1XZNNCCn7xhBNbhaIbsBubky3BEj06zWp/view?usp=sharing parkour.ifp]), and replaces the internal crouch animation from ped block with a custom animation. If you press C on your keyboard, the custom animation will be played instead of crouch animation.

<syntaxhighlight lang="lua">
--[[
credits to Paul_Cortez for the IFP file.
parkour.ifp has following animations:

BckHndSpingBTuck
BckHndSping
CartWheel
FrntHndSpring
HandPlant
]]

-- you can choose any name you want, do not choose a default GTA:SA block name
local customBlockName = "myNewBlock"

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

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

-- replace the crouch animation
engineReplaceAnimation( localPlayer, "ped", "weapon_crouch", customBlockName, "HandPlant" )
</syntaxhighlight>

==See Also==
{{Engine_functions}}

DxDrawCircle

2018-08-10T20:05:44Z

Saml1er: fixed postGUI parameter name

{{Client Function}}
<lowercasetitle/>
__NOTOC__
{{New feature/item|3.0156|1.5.5|13977|This function draws a circle shape on the screen - rendered for '''one''' frame. This should be used in conjunction with [[onClientRender]] in order to be display continuously.}}

==Syntax==
<syntaxhighlight lang="lua">bool dxDrawCircle ( float posX, float posY, float radius [, float startAngle = 0.0, float stopAngle = 360.0, color theColor = white,
color theCenterColor = theColor, int segments = 32, int ratio = 1, postGUI = false ] )</syntaxhighlight>

===Required Arguments===
[[Image:DxDrawCircle_Saml1er.png|thumb|An example of how dxDrawCircle function works in practice.]]

* '''posX''': An integer representing the '''absolute''' X position of the circle center, represented by pixels on the screen.
* '''posY''': An integer representing the '''absolute''' Y position of the circle center, represented by pixels on the screen.
* '''radius''': An integer representing the radius scale of the circle that is being drawn.

===Optional Arguments===
{{OptionalArg}}
* '''startAngle''': An integer representing the angle of the first point of the circle.
* '''stopAngle''': An integer representing the angle of the last point of the circle.
* '''theColor''': An integer of the hex color, produced using [[tocolor]] or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).
* '''theCenterColor''': An integer of the hex color, produced using [[tocolor]] or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).
* '''segments''': An integer ranging from 3-1024 representing how many triangles are used to form the circle, more segments = smoother circle. Note: using lots of segments may cause lag.
* '''ratio''': Ratio between width and height, e.g: 2 would mean that the width of the circle is 2 times the height.
* '''postGUI''': A bool representing whether the circle should be drawn on top of or behind any ingame GUI (rendered by CEGUI).

===Returns===
Returns ''true'' if the creation of the 2D circle was successful, ''false'' otherwise.

==Example==
This function draws a rectangle with rounded corners.
<syntaxhighlight lang="lua">
function dxDrawRoundedRectangle(x, y, rx, ry, color, radius)
rx = rx - radius * 2
ry = ry - radius * 2
x = x + radius
y = y + radius

if (rx >= 0) and (ry >= 0) then
dxDrawRectangle(x, y, rx, ry, color)
dxDrawRectangle(x, y - radius, rx, radius, color)
dxDrawRectangle(x, y + ry, rx, radius, color)
dxDrawRectangle(x - radius, y, radius, ry, color)
dxDrawRectangle(x + rx, y, radius, ry, color)

dxDrawCircle(x, y, radius, 180, 270, color, color, 7)
dxDrawCircle(x + rx, y, radius, 270, 360, color, color, 7)
dxDrawCircle(x + rx, y + ry, radius, 0, 90, color, color, 7)
dxDrawCircle(x, y + ry, radius, 90, 180, color, color, 7)
end
end
dxDrawRoundedRectangle(350, 50, 100, 100, tocolor(0, 255, 0, 255), 20)
</syntaxhighlight>

==See Also==
{{Drawing_functions}}

DxDrawCircle

2018-08-04T18:07:13Z

Saml1er: Changed example image.

{{Client Function}}
<lowercasetitle/>
__NOTOC__
{{New feature/item|3.0156|1.5.6||This function draws a circle shape on the screen - rendered for '''one''' frame. This should be used in conjunction with [[onClientRender]] in order to be display continuously.}}

==Syntax==
<syntaxhighlight lang="lua">bool dxDrawCircle ( float posX, float posY, float radius [, float startAngle = 0.0, float stopAngle = 360.0, color theColor = white,
color theCenterColor = theColor, int segments = 32, int ratio = 1, bPostGUI = false ] )</syntaxhighlight>

===Required Arguments===
[[Image:DxDrawCircle_Saml1er.png|thumb|An example of how dxDrawCircle function works in practice.]]

* '''posX''': An integer representing the '''absolute''' X position of the circle center, represented by pixels on the screen.
* '''posY''': An integer representing the '''absolute''' Y position of the circle center, represented by pixels on the screen.
* '''radius''': An integer representing the radius scale of the circle that is being drawn.

===Optional Arguments===
{{OptionalArg}}
* '''startAngle''': An integer representing the angle of the first point of the circle.
* '''stopAngle''': An integer representing the angle of the last point of the circle.
* '''theColor''': An integer of the hex color, produced using [[tocolor]] or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).
* '''theCenterColor''': An integer of the hex color, produced using [[tocolor]] or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).
* '''segments''': An integer ranging from 3-1024 representing how many triangles are used to form the circle, more segments = smoother circle. Note: using lots of segments may cause lag.
* '''ratio''': Ratio between width and height, e.g: 2 would mean that the width of the circle is 2 times the height.
* '''postGUI''': A bool representing whether the circle should be drawn on top of or behind any ingame GUI (rendered by CEGUI).

===Returns===
Returns ''true'' if the creation of the 2D circle was successful, ''false'' otherwise.

==Example==
This function draws a rectangle with rounded corners.
<syntaxhighlight lang="lua">
function dxDrawRoundedRectangle(x, y, rx, ry, color, radius)
rx = rx - radius * 2
ry = ry - radius * 2
x = x + radius
y = y + radius

if (rx >= 0) and (ry >= 0) then
dxDrawRectangle(x, y, rx, ry, color)
dxDrawRectangle(x, y - radius, rx, radius, color)
dxDrawRectangle(x, y + ry, rx, radius, color)
dxDrawRectangle(x - radius, y, radius, ry, color)
dxDrawRectangle(x + rx, y, radius, ry, color)

dxDrawCircle(x, y, radius, 180, 270, color, color, 7)
dxDrawCircle(x + rx, y, radius, 270, 360, color, color, 7)
dxDrawCircle(x + rx, y + ry, radius, 0, 90, color, color, 7)
dxDrawCircle(x, y + ry, radius, 90, 180, color, color, 7)
end
end
dxDrawRoundedRectangle(350, 50, 100, 100, tocolor(0, 255, 0, 255), 20)
</syntaxhighlight>

==See Also==
{{Drawing_functions}}

File:DxDrawCircle Saml1er.png

2018-08-04T18:05:24Z

Saml1er: This image shows that you can draw a circle up to 360° using DxDrawCircle function by CrosRoad95.

This image shows that you can draw a circle up to 360° using DxDrawCircle function by CrosRoad95.

Coding info

2018-07-30T08:19:55Z

Saml1er: Added IFP

== Introduction ==

This page has information which would be useful for anyone who is doing coding for MTA SA. [[Coding guidelines]] also has a lot of useful info.

== Projects explained ==

* Client - Core: Typically UI elements like main menu etc and isn't ever unloaded.
* Client - Deathmatch: Where MTA makes all it's functions and events do stuff.
* Client - Game SA: Low level stuff which is mainly function calls to the game so each element will have a game_sa class like Vehicle, Ped, Object etc.
* Client - GUI: It's just wrappers to CEGUI, you need not touch.
* Client - Launch: Is the MTA executable which loads loader, you need not touch.
* Client - Loader: You need not touch the loader either.
* Client - Multiplayer SA: Hooks, code modification and that sort of low level things that lets us work.
* Server - Core: Cazomino05: "I genuinely don't really know why we have server core."
* Server - Dbconmy: Stuff to do with the db* functions, you need not touch.
* Server - Deathmatch: All the server logic and storage classes for elements as well as Lua stuff.
* Server - Launcher: Just an executable to load all the DLLs we need.
* Shared - XML Module: XML module is just tinyxml and some high level wrapper functions for stuff we need.
* Dependencies: Has a load of 3rd party code, modules like sqlite, curl, lua, ehs, etc.
* CEGUI: Crazy Eddie's GUI system is a graphical user interface C++ library.

Some of the code may be explained in detail in pages under the this category: [[:Category:Classes (Blue)|Classes (Blue)]]

== Simplification of data types ==

MTA has some type definitions you can use (Can be found in Shared/sdk/SharedUtil.h)

* ulong = unsigned long
* uint = unsigned int
* ushort = unsigned short
* uchar = unsigned char
* uint64 = unsigned long long
* uint32 = unsigned int
* uint16 = unsigned short
* uint8 = unsigned char
* int64 = signed long long
* int32 = signed int
* int16 = signed short
* int8 = signed char
* BYTE = unsigned char
* WORD = unsigned short
* DWORD = unsigned long
* FLOAT = float

== Debug Commands ==

MTA has some commands which you can use if you're running debug mode

* showsync - show sync data
* foo - debug command for devs
* showwepdata - shows the given player weapon data (nick)
* showtasks - shows the local player tasks (nick)
* showplayer - shows extended player information (nick)
* setmimic - enables player mimics (amount)
* setmimiclag - enables player mimic lag (amount)
* paintballs - enables paintball mode
* breakpoint - inserts breakpoint
* giveweapon - gives the player a weapon (id)
* showrpcs - shows the remote prodecure calls
* showinterpolation - shows information about the interpolation
* watch - enables wpm watch mode
* modules - enables wpm module
* debug - debug function 1
* debug2 - debug function 2
* debug3 - debug function 3
* debug4 - debug function 4

== Entity types ==

* CCLIENTCAMERA - Camera
* CCLIENTPLAYER - Player
* CCLIENTVEHICLE - Vehicle
* CCLIENTRADARMARKER - Blip
* CCLIENTOBJECT - Object
* CCLIENTPICKUP - Pickup
* CCLIENTRADARAREA - RadarArea
* CCLIENTMARKER - Marker
* CCLIENTTEAM - Team
* CCLIENTPED - Ped
* CCLIENTPROJECTILE - Projectile
* CCLIENTIFP - EngineIFP
* CCLIENTGUI:
* CGUI_BUTTON - GuiButton
* CGUI_CHECKBOX - GuiCheckBox
* CGUI_EDIT - GuiEdit
* CGUI_GRIDLIST - GuiGridList
* CGUI_LABEL - GuiLabel
* CGUI_MEMO - GuiMemo
* CGUI_PROGRESSBAR - GuiProgressBar
* CGUI_RADIOBUTTON - GuiRadioButton
* CGUI_STATICIMAGE - GuiStaticImage
* CGUI_TAB - GuiTab
* CGUI_TABPANEL - GuiTabPanel
* CGUI_WINDOW - GuiWindow
* CGUI_SCROLLPANE - GuiScrollPane
* CGUI_SCROLLBAR - GuiScrollBar
* CGUI_COMBOBOX - GuiComboBox
* CCLIENTCOLSHAPE - ColShape
* SCRIPTFILE - File
* CCLIENTDFF - EngineDFF
* CCLIENTCOL - EngineCOL
* CCLIENTTXD - EngineTXD
* CCLIENTSOUND - Sound
* CCLIENTWATER - Water
* CCLIENTDXFONT - DxFont
* CCLIENTGUIFONT - GuiFont
* CCLIENTTEXTURE - DxTexture
* CCLIENTSHADER - DxShader
* CCLIENTWEAPON - Weapon
* CCLIENTEFFECT - Effect
* CCLIENTSCREENSOURCE - DxScreenSource
* CCLIENTRENDERTARGET - DxRenderTarget

[[Category: Development]]

Coding guidelines

2018-07-30T08:12:48Z

Saml1er: Removed deprecated instructions, and updated with latest coding guidelines

= Introduction =

So you've decided to become a contributor to our project. Excellent! But before we can start accepting your code, there are a couple of things you should know about how we work. These are mostly guidelines and rules as to how your code should be structured and how it can be committed without upsetting any fellow contributors.

= Code repository =

== Structure ==
Our code repository uses Git and is structured into number of different directories, which serve different purposes:

* '''Client'''
* '''Server'''
* '''Shared''': contains code shared between both the client and the server
* '''irc''': bot code for the Multi Theft Auto IRC channels
* '''m4'''
* '''utils''': utilities used to automate certain tasks
* '''vendor''': unmodified third-party code and libraries (optionally linked to the appropriate third-party Git repository through Git submodules).

Our branches contain groundbreaking research, radical ideas and other work-in-progress that is meant to be merged into the trunk at a later point, but also contains project milestones:

* The master branch is the main development branch (containing the latest, bleeding-edge code)
* Project milestones are kept away from the trunk for stability reasons, but the latest version branch can be used by any regular player who has enabled nightly builds. Make sure that only well tested code is added to the latest version branch.

== Gaining and Losing Commit access ==
Commit access is granted after patches have been submitted, and the coder has proven to be competent. The subject matter of the patches does not matter, we are more interested in whether if you are granted commit access, you will be capable of maintaining a high standard of code and remaining cohesive with other project contributors.

Patches can be submitted using [https://github.com/multitheftauto/mtasa-blue/pull/new GitHub's pull request system]. Usually commit access is gained after 2-3 patches, but this is not fixed and depends on the extent of the contributions. This requires you to fork our repository and make commits to your own branch first.

After gaining commit access, if the contributor's commits are of a consistently low standard, or the user fails to stick to the rules, their commit access will be stripped and will be required to submit pull requests again.

== Committing code ==
Keep in mind that your commits should initially be fixing or implementing existing issues on our [http://bugs.mtasa.com bug tracker]. The [http://bugs.mtasa.com/roadmap_page.php roadmap] is particularly important since it allows contributors to track down priority issues.

Please follow these guidelines for all your contributions:
* Commits should be thoroughly tested when added to master. Commits that 'need to be fixed later' which directly affect the state of the mod will be reverted other than in exceptional circumstances.
* If writing unstable or experimental code, a private branch should be added in your own fork. Branches should not be "personal" to each user. This means that a branch should be created for a new feature, not for a user specific playground.
* Commit messages should always give a clear indication of the content of the change, without having to look at the code at all. Where appropriate, include the Mantis Issue number in your log message and keep your log messages consistent, e.g. '''Fix #1234: description and notes here'''. [http://chris.beams.io/posts/git-commit/ Follow the seven rules identified here.]
* When committing updates to previous commits, include the previous commit SHA (and a summarised commit message) in the new commit message. Doing this will help identify related commits if they are viewed at a later date.

== Ratings and comments ==
Ratings and comments are open for the public to review code and provide feedback. Please be mature and civilised when posting comments. Developers should try to review other contributor's commits and provide feedback as much as possible.

Make sure you make appropriate use of the GitHub Reactions feature to rate commits or express agreement/disagreement to a comment. This avoids spammy comments such as "+1", "-1", "Nice one!", etc.

Since you can only react to comments, not commits, feel free to create the initial "+1" comment in response to a commit. However, future reactions to a commit should be to the first response comment.

== What to code ==
Generally, developers should try to stick to the [http://bugs.mtasa.com/roadmap_page.php roadmap] when coding. This lists the issues required to be resolved for the next release. Of course, if you're interested in something else, feel free to experiment and submit it.

== Style ==
* We use 4 spaces instead of tabs.
* Hungarian notation for variable names.
float fValue; // Local variable
unsigned char m_ucValue; // Class member variable
char ms_cValue; // Class static variable
bool g_bCrashTwiceAnHour; // Global variable
char* szUsername; // Zero terminated string
SString strUsername; // String
CVector vecPosition; // 3D Vector
* Lower camel case for variable names of types like custom structs and enums:
SSomeStruct valueOne;
ESomeEnum m_valueTwo;
* Function names use UpperCamelCase:
void UpperCamelCase()
* Functions with no arguments are declared and defined with (), and called with ()
void MyTest();
void MyTest() { return; }
MyTest();
* Put ''#pragma once'' preprocessor directive next to the copyright comment for new header files and the ones you are modifying for the pull request. Make sure to remove include guard if you are using ''#pragma once'':
<nowiki>/*****************************************************************************

*
* PROJECT: Multi Theft Auto
* LICENSE: See LICENSE in the top level directory
* FILE: Client/mods/deathmatch/logic/CClientIFP.h
*
* Multi Theft Auto is available from http://www.multitheftauto.com/
*
*****************************************************************************/

#pragma once</nowiki>
* Once you're done writing code, and you're about to create a pull request, apply clang formatting:
** Download [http://prereleases.llvm.org/win-snapshots/clang-format-r325576.exe clang-format-r325576.exe], and move it to '''utils''' folder.
** Download [http://findandreplace.io/downloads/fnr.zip fnr.zip], extract fnr.exe to '''utils''' folder.
** Run '''utils\win-apply-clang-format.bat'''.

* For anything else, follow the style of the code that already exists.

* Tip: In Visual Studio go to Tools -> Options -> Text Editor -> C/C++ -> Formatting -> Spacing and you can configure it to automatically apply the right spacing.

== Coding info ==
Check out the [[Coding info]] page and feel free to add more coding info to it.

[[Category: Development]]

Template:Engine functions

2018-07-18T17:55:54Z

Saml1er: Undo revision 55710 by Saml1er (talk)

* [[engineApplyShaderToWorldTexture]]
* [[engineGetModelIDFromName]]
* [[engineGetModelLODDistance]]
* [[engineGetModelNameFromID]]
* [[engineGetModelTextureNames]]
* [[engineGetVisibleTextureNames]]
* [[engineImportTXD]]
* [[engineLoadCOL]]
* [[engineLoadDFF]]
* [[engineLoadTXD]]
{{New items|3.0156|1.5.5|
* [[engineLoadIFP]]
* [[engineReplaceAnimation]]
* [[engineRestoreAnimation]]
|12195}}
* [[engineRemoveShaderFromWorldTexture]]
* [[engineReplaceCOL]]
* [[engineReplaceModel]]
* [[engineRestoreCOL]]
* [[engineRestoreModel]]
* [[engineSetAsynchronousLoading]]
* [[engineSetModelLODDistance]]

<noinclude>[[Category:Functions templates]]</noinclude>

EngineRestoreAnimation

2018-07-18T17:55:20Z

Saml1er: Restored version transclusion

__NOTOC__
{{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]].

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 3rd parameter (animation name) is provided, then only that specific animation within that specific block is restored.}}

==Syntax==
<syntaxhighlight lang="lua">
bool engineRestoreAnimation ( ped thePed [, string InternalBlockName, string InternalAnimName ] )
</syntaxhighlight>

===Required Arguments===
*'''thePed:''' the [[player]] or [[ped]] you want to restore an animation(s) for.

===Optional Arguments===
{{OptionalArg}}
*'''InternalBlockName:''' the [[Animations|internal block]] name.
*'''InternalAnimName:''' the [[Animations|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.
<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">
engineRestoreAnimation( localPLayer, "ped", "weapon_crouch" )
</syntaxhighlight>

==See Also==
{{Engine_functions}}

EngineReplaceAnimation

2018-07-18T17:54:39Z

Saml1er: Restored version transclusion

__NOTOC__
{{Client function}}
{{Warning|engineReplaceAnimation does not apply the replaced animation if it is currently being used, for instance, the idle animation.|true}}
{{New feature/item|3.0156|1.5.5|12195|
This function replaces a specific internal (default) animation with a custom one that has been loaded using [[EngineLoadIFP|engineLoadIFP]] function. This function only affects a specific [[player]] or [[ped]], the [[Animations|internal animation]] is not replaced for everyone, for instance, different players and peds are able to have completely different crouching, walking, and fighting etc., animations running simultaneously at the same time. Also, it's not synchronized, you'll need to execute this function on every client in Lua to synchronize it.

Internal animations replaced using this function can still be played with [[SetPedAnimation|setPedAnimation]]. You can restore replaced animations back with [[EngineRestoreAnimation|engineRestoreAnimation]].

It should be noted that partial animations are not supported, you can still replace them, but they won't work as intended, for example, "FightA_block" animation from "ped" block is a partial animation, you can't replace it properly, only a few animations are partial, rest of them are not, so it shouldn't be a problem.}}

==Syntax==
<syntaxhighlight lang="lua">
bool engineReplaceAnimation ( ped thePed, string InternalBlockName, string InternalAnimName, string CustomBlockName, string CustomAnimName )
</syntaxhighlight>

===Required Arguments===
*'''thePed:''' the [[player]] or [[ped]] you want to replace an animation for.
*'''InternalBlockName:''' the [[Animations|internal block]] name.
*'''InternalAnimName:''' the [[Animations|internal animation]] name inside InternalBlockName.
*'''CustomBlockName:''' the custom block name of the loaded IFP file that you passed to [[EngineLoadIFP|engineLoadIFP]] as second parameter.
*'''CustomAnimName:''' the custom animation name inside the loaded IFP file with CustomBlockName.
===Returns===
Returns ''true'' on success, ''false'' in case of failure.

==Example==
This example loads a custom IFP file ([https://drive.google.com/file/d/1XZNNCCn7xhBNbhaIbsBubky3BEj06zWp/view?usp=sharing parkour.ifp]), and replaces the internal crouch animation from ped block with a custom animation. If you press C on your keyboard, the custom animation will be played instead of crouch animation.

<syntaxhighlight lang="lua">
--[[
credits to Paul_Cortez for the IFP file.
parkour.ifp has following animations:

BckHndSpingBTuck
BckHndSping
CartWheel
FrntHndSpring
HandPlant
]]

-- you can choose any name you want, do not choose a default GTA:SA block name
local customBlockName = "myNewBlock"

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

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

-- replace the crouch animation
engineReplaceAnimation( localPlayer, "ped", "weapon_crouch", customBlockName, "HandPlant" )
</syntaxhighlight>

==See Also==
{{Engine_functions}}

EngineLoadIFP

2018-07-18T17:52:12Z

Saml1er: Undo revision 55707 by Saml1er (talk)

{{Client function}}
__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]].

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==
<syntaxhighlight lang="lua">
ifp engineLoadIFP ( string IfpFilePath, string CustomBlockName )
</syntaxhighlight>

===Required Arguments===
*'''IfpFilePath:''' the [[filepath|file path]] to the IFP file you want to load.
*'''CustomBlockName:''' the new block name for the IFP file. You cannot use the GTA default [[Animations|internal block]] names.

===Returns===
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}}

==Example==
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.

<syntaxhighlight lang="lua">
--[[
credits to Paul_Cortez for the IFP file.
parkour.ifp has following animations:

BckHndSpingBTuck
BckHndSping
CartWheel
FrntHndSpring
HandPlant
]]

-- you can choose any name you want, do not choose a default GTA:SA block name
local customBlockName = "myNewBlock"

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

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

-- execute the command using /animation <NameOfCustomAnimation>
-- for example, /animation CartWheel
function setanimation( _, animationName )
-- check if IFP file has loaded
if IFP then
-- now play our custom animation
setPedAnimation( localPlayer, customBlockName, animationName )
end
end
addCommandHandler( "animation", setanimation )
</syntaxhighlight>

==See Also==
{{Engine_functions}}

EngineReplaceAnimation

2018-07-17T00:06:11Z

Saml1er: Added warning

__NOTOC__
{{Client function}}
{{Warning|engineReplaceAnimation does not apply the replaced animation if it is currently being used, for instance, the idle animation.|true}}

This function replaces a specific internal (default) animation with a custom one that has been loaded using [[EngineLoadIFP|engineLoadIFP]] function. This function only affects a specific [[player]] or [[ped]], the [[Animations|internal animation]] is not replaced for everyone, for instance, different players and peds are able to have completely different crouching, walking, and fighting etc., animations running simultaneously at the same time. Also, it's not synchronized, you'll need to execute this function on every client in Lua to synchronize it.

Internal animations replaced using this function can still be played with [[SetPedAnimation|setPedAnimation]]. You can restore replaced animations back with [[EngineRestoreAnimation|engineRestoreAnimation]].

It should be noted that partial animations are not supported, you can still replace them, but they won't work as intended, for example, "FightA_block" animation from "ped" block is a partial animation, you can't replace it properly, only a few animations are partial, rest of them are not, so it shouldn't be a problem.

==Syntax==
<syntaxhighlight lang="lua">
bool engineReplaceAnimation ( ped thePed, string InternalBlockName, string InternalAnimName, string CustomBlockName, string CustomAnimName )
</syntaxhighlight>

===Required Arguments===
*'''thePed:''' the [[player]] or [[ped]] you want to replace an animation for.
*'''InternalBlockName:''' the [[Animations|internal block]] name.
*'''InternalAnimName:''' the [[Animations|internal animation]] name inside InternalBlockName.
*'''CustomBlockName:''' the custom block name of the loaded IFP file that you passed to [[EngineLoadIFP|engineLoadIFP]] as second parameter.
*'''CustomAnimName:''' the custom animation name inside the loaded IFP file with CustomBlockName.
===Returns===
Returns ''true'' on success, ''false'' in case of failure.

==Example==
This example loads a custom IFP file ([https://drive.google.com/file/d/1XZNNCCn7xhBNbhaIbsBubky3BEj06zWp/view?usp=sharing parkour.ifp]), and replaces the internal crouch animation from ped block with a custom animation. If you press C on your keyboard, the custom animation will be played instead of crouch animation.

<syntaxhighlight lang="lua">
--[[
credits to Paul_Cortez for the IFP file.
parkour.ifp has following animations:

BckHndSpingBTuck
BckHndSping
CartWheel
FrntHndSpring
HandPlant
]]

-- you can choose any name you want, do not choose a default GTA:SA block name
local customBlockName = "myNewBlock"

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

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

-- replace the crouch animation
engineReplaceAnimation( localPlayer, "ped", "weapon_crouch", customBlockName, "HandPlant" )
</syntaxhighlight>

==See Also==
{{Engine_functions}}

SetPedAnimation

2018-07-17T00:00:10Z

Saml1er: Fix space between warning and he header

__NOTOC__
{{Server client function}}
{{Warning|It's not possible to play the replaced animation immediately after calling engineReplaceAnimation via setPedAnimation.|true}}

Sets the current [[Animations|animation]] of a [[player]] or [[ped]]. Not specifying the type of animation will automatically cancel the current one.

==Syntax==
<syntaxhighlight lang="lua">
bool setPedAnimation ( ped thePed [, string block=nil, string anim=nil, int time=-1, bool loop=true, bool updatePosition=true, bool interruptable=true, bool freezeLastFrame=true, int blendTime=250] )
</syntaxhighlight>
{{OOP||[[ped]]:setAnimation||getPedAnimation}}

===Required Arguments===
*'''thePed:''' the [[player]] or [[ped]] you want to apply an [[Animations|animation]] to.

===Optional Arguments===
{{OptionalArg}}
*'''block:''' the [[Animations|animation]] block's name.
*'''anim:''' the name of the [[Animations|animation]] within the block.
*'''time:''' how long the animation will run for in milliseconds.
*'''loop:''' indicates whether or not the animation will loop.
*'''updatePosition:''' will change the actual coordinates of the ped according to the animation. Use this for e.g. walking animations.
*'''interruptable:''' if set to ''false'' other tasks wont be able to interupt the animation. Setting this to 'false' also gives this function more power to override other animations that are running. For example, squatting after a jump can be terminated.
*'''freezeLastFrame:''' if set to ''true'' after animation the last frame will be frozen, otherwise the animation will end and controls will return.
*'''blendTime:''' how long the animation will mixed with the previous one in milliseconds.

===Returns===
Returns ''true'' if succesful, ''false'' otherwise.

==Examples==

<section name="Server" class="server" show="true">
This example creates a ped, rotates him, and makes him walk:
<syntaxhighlight lang="lua">
function makePed()
local thePed = createPed(56, 1, 1, 4, 315)
setPedAnimation(thePed, "ped", "WOMAN_walknorm")
end
addCommandHandler("makemyped", makePed)
</syntaxhighlight>
</section>

<section name="Server" class="server" show="true">
This example makes the player sit down and stand up using the command /sit.
<syntaxhighlight lang="lua">
function toggleSit(thePlayer)
if not getElementData(thePlayer, "sitting") then
setPedAnimation(thePlayer, "ped", "seat_down", -1, false, false, false, false)
setElementData(thePlayer, "sitting", true)
else
-- If you use again this command then your character stand up
setPedAnimation(thePlayer)
removeElementData(thePlayer, "sitting")
end
end
addCommandHandler("sit", toggleSit)
</syntaxhighlight>
</section>

==Issues==
{{Issues|
{{Issue|9522|Setting a [[ped|ped's]] or [[player|player's]] animation whilst occupying a [[givePedJetPack|jetpack]] will remove their jetpack, but not the jetpack sound}}
}}

==See Also==
{{Ped_functions}}
[[ru:setPedAnimation]]

SetPedAnimation

2018-07-16T23:59:12Z

Saml1er: Added warning

__NOTOC__
{{Server client function}}

{{Warning|It's not possible to play the replaced animation immediately after calling engineReplaceAnimation via setPedAnimation.|true}}
Sets the current [[Animations|animation]] of a [[player]] or [[ped]]. Not specifying the type of animation will automatically cancel the current one.

==Syntax==
<syntaxhighlight lang="lua">
bool setPedAnimation ( ped thePed [, string block=nil, string anim=nil, int time=-1, bool loop=true, bool updatePosition=true, bool interruptable=true, bool freezeLastFrame=true, int blendTime=250] )
</syntaxhighlight>
{{OOP||[[ped]]:setAnimation||getPedAnimation}}

===Required Arguments===
*'''thePed:''' the [[player]] or [[ped]] you want to apply an [[Animations|animation]] to.

===Optional Arguments===
{{OptionalArg}}
*'''block:''' the [[Animations|animation]] block's name.
*'''anim:''' the name of the [[Animations|animation]] within the block.
*'''time:''' how long the animation will run for in milliseconds.
*'''loop:''' indicates whether or not the animation will loop.
*'''updatePosition:''' will change the actual coordinates of the ped according to the animation. Use this for e.g. walking animations.
*'''interruptable:''' if set to ''false'' other tasks wont be able to interupt the animation. Setting this to 'false' also gives this function more power to override other animations that are running. For example, squatting after a jump can be terminated.
*'''freezeLastFrame:''' if set to ''true'' after animation the last frame will be frozen, otherwise the animation will end and controls will return.
*'''blendTime:''' how long the animation will mixed with the previous one in milliseconds.

===Returns===
Returns ''true'' if succesful, ''false'' otherwise.

==Examples==

<section name="Server" class="server" show="true">
This example creates a ped, rotates him, and makes him walk:
<syntaxhighlight lang="lua">
function makePed()
local thePed = createPed(56, 1, 1, 4, 315)
setPedAnimation(thePed, "ped", "WOMAN_walknorm")
end
addCommandHandler("makemyped", makePed)
</syntaxhighlight>
</section>

<section name="Server" class="server" show="true">
This example makes the player sit down and stand up using the command /sit.
<syntaxhighlight lang="lua">
function toggleSit(thePlayer)
if not getElementData(thePlayer, "sitting") then
setPedAnimation(thePlayer, "ped", "seat_down", -1, false, false, false, false)
setElementData(thePlayer, "sitting", true)
else
-- If you use again this command then your character stand up
setPedAnimation(thePlayer)
removeElementData(thePlayer, "sitting")
end
end
addCommandHandler("sit", toggleSit)
</syntaxhighlight>
</section>

==Issues==
{{Issues|
{{Issue|9522|Setting a [[ped|ped's]] or [[player|player's]] animation whilst occupying a [[givePedJetPack|jetpack]] will remove their jetpack, but not the jetpack sound}}
}}

==See Also==
{{Ped_functions}}
[[ru:setPedAnimation]]

Template:Engine functions

2018-07-07T09:54:24Z

Saml1er: Removed version transclusion for ifp functions

* [[engineApplyShaderToWorldTexture]]
* [[engineGetModelIDFromName]]
* [[engineGetModelLODDistance]]
* [[engineGetModelNameFromID]]
* [[engineGetModelTextureNames]]
* [[engineGetVisibleTextureNames]]
* [[engineImportTXD]]
* [[engineLoadCOL]]
* [[engineLoadDFF]]
* [[engineLoadTXD]]
* [[engineLoadIFP]]
* [[engineReplaceAnimation]]
* [[engineRestoreAnimation]]
* [[engineRemoveShaderFromWorldTexture]]
* [[engineReplaceCOL]]
* [[engineReplaceModel]]
* [[engineRestoreCOL]]
* [[engineRestoreModel]]
* [[engineSetAsynchronousLoading]]
* [[engineSetModelLODDistance]]

<noinclude>[[Category:Functions templates]]</noinclude>

EngineRestoreAnimation

2018-07-07T09:53:12Z

Saml1er: Removed version transclusion

__NOTOC__
{{Client function}}
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 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==
<syntaxhighlight lang="lua">
bool engineRestoreAnimation ( ped thePed [, string InternalBlockName, string InternalAnimName ] )
</syntaxhighlight>

===Required Arguments===
*'''thePed:''' the [[player]] or [[ped]] you want to restore an animation(s) for.

===Optional Arguments===
{{OptionalArg}}
*'''InternalBlockName:''' the [[Animations|internal block]] name.
*'''InternalAnimName:''' the [[Animations|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.
<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">
engineRestoreAnimation( localPLayer, "ped", "weapon_crouch" )
</syntaxhighlight>

==See Also==
{{Engine_functions}}

EngineReplaceAnimation

2018-07-07T09:52:57Z

Saml1er: Removed version transclusion

__NOTOC__
{{Client function}}
This function replaces a specific internal (default) animation with a custom one that has been loaded using [[EngineLoadIFP|engineLoadIFP]] function. This function only affects a specific [[player]] or [[ped]], the [[Animations|internal animation]] is not replaced for everyone, for instance, different players and peds are able to have completely different crouching, walking, and fighting etc., animations running simultaneously at the same time. Also, it's not synchronized, you'll need to execute this function on every client in Lua to synchronize it.

Internal animations replaced using this function can still be played with [[SetPedAnimation|setPedAnimation]]. You can restore replaced animations back with [[EngineRestoreAnimation|engineRestoreAnimation]].

It should be noted that partial animations are not supported, you can still replace them, but they won't work as intended, for example, "FightA_block" animation from "ped" block is a partial animation, you can't replace it properly, only a few animations are partial, rest of them are not, so it shouldn't be a problem.

==Syntax==
<syntaxhighlight lang="lua">
bool engineReplaceAnimation ( ped thePed, string InternalBlockName, string InternalAnimName, string CustomBlockName, string CustomAnimName )
</syntaxhighlight>

===Required Arguments===
*'''thePed:''' the [[player]] or [[ped]] you want to replace an animation for.
*'''InternalBlockName:''' the [[Animations|internal block]] name.
*'''InternalAnimName:''' the [[Animations|internal animation]] name inside InternalBlockName.
*'''CustomBlockName:''' the custom block name of the loaded IFP file that you passed to [[EngineLoadIFP|engineLoadIFP]] as second parameter.
*'''CustomAnimName:''' the custom animation name inside the loaded IFP file with CustomBlockName.
===Returns===
Returns ''true'' on success, ''false'' in case of failure.

==Example==
This example loads a custom IFP file ([https://drive.google.com/file/d/1XZNNCCn7xhBNbhaIbsBubky3BEj06zWp/view?usp=sharing parkour.ifp]), and replaces the internal crouch animation from ped block with a custom animation. If you press C on your keyboard, the custom animation will be played instead of crouch animation.

<syntaxhighlight lang="lua">
--[[
credits to Paul_Cortez for the IFP file.
parkour.ifp has following animations:

BckHndSpingBTuck
BckHndSping
CartWheel
FrntHndSpring
HandPlant
]]

-- you can choose any name you want, do not choose a default GTA:SA block name
local customBlockName = "myNewBlock"

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

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

-- replace the crouch animation
engineReplaceAnimation( localPlayer, "ped", "weapon_crouch", customBlockName, "HandPlant" )
</syntaxhighlight>

==See Also==
{{Engine_functions}}

EngineLoadIFP

2018-07-07T09:52:30Z

Saml1er: Removed version transclusion

{{Client function}}
__NOTOC__
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.
==Syntax==
<syntaxhighlight lang="lua">
ifp engineLoadIFP ( string IfpFilePath, string CustomBlockName )
</syntaxhighlight>

===Required Arguments===
*'''IfpFilePath:''' the [[filepath|file path]] to the IFP file you want to load.
*'''CustomBlockName:''' the new block name for the IFP file. You cannot use the GTA default [[Animations|internal block]] names.

===Returns===
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}}

==Example==
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.

<syntaxhighlight lang="lua">
--[[
credits to Paul_Cortez for the IFP file.
parkour.ifp has following animations:

BckHndSpingBTuck
BckHndSping
CartWheel
FrntHndSpring
HandPlant
]]

-- you can choose any name you want, do not choose a default GTA:SA block name
local customBlockName = "myNewBlock"

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

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

-- execute the command using /animation <NameOfCustomAnimation>
-- for example, /animation CartWheel
function setanimation( _, animationName )
-- check if IFP file has loaded
if IFP then
-- now play our custom animation
setPedAnimation( localPlayer, customBlockName, animationName )
end
end
addCommandHandler( "animation", setanimation )
</syntaxhighlight>

==See Also==
{{Engine_functions}}

SetVehicleHandling

2018-06-23T01:03:15Z

Saml1er: Undo revision 55407 by Saml1er (talk)

{{Server function}}
__NOTOC__
This function is used to change the handling data of a vehicle.

==Syntax==
<syntaxhighlight lang="lua">
bool setVehicleHandling ( element theVehicle, string property, var value )
</syntaxhighlight>

Syntaxes for reset configurations:
<syntaxhighlight lang="lua">
bool setVehicleHandling ( element theVehicle, string property, nil, false ) -- Reset one property to model handling value
bool setVehicleHandling ( element theVehicle, string property, nil, true ) -- Reset one property to GTA default value
bool setVehicleHandling ( element theVehicle, false ) -- Reset all properties to model handling value
bool setVehicleHandling ( element theVehicle, true ) -- Reset all properties to GTA default value
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The vehicle you wish to set the handling of.
*'''property:''' The property you wish to set the handling of the vehicle to.
{{Handling Properties}}
*'''value:''' The value of the property you wish to set the handling of the vehicle to.

===Returns===
Returns ''true'' if the handling was set successfully, ''false'' otherwise. See below a list of valid properties and their required values:

==Notes==
for functionality reasons suspension modification is disabled on monster trucks, trains, boats and trailers.

==Example==
This example will make Infernus handling very fast and also make it damage proof from collision (handling by Mr.unpredictable).
this example will help you in creating your own vehicle Handling.
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function vhandling ( )
for _,v in pairs(getElementsByType("vehicle")) do
if getElementModel(v) == 411 then -------------- vehicle Id
setVehicleHandling (v, "mass", 300.0)
setVehicleHandling(v, "turnMass", 200)
setVehicleHandling(v, "dragCoeff", 4.0 )
setVehicleHandling(v, "centerOfMass", { 0.0,0.08,-0.09 } )
setVehicleHandling(v, "percentSubmerged", 103)
setVehicleHandling(v, "tractionMultiplier", 1.8)
setVehicleHandling(v, "tractionLoss", 1.0)
setVehicleHandling(v, "tractionBias", 0.48)
setVehicleHandling(v, "numberOfGears", 5)
setVehicleHandling(v, "maxVelocity", 300.0)
setVehicleHandling(v, "engineAcceleration", 90.0 )
setVehicleHandling(v, "engineInertia", 5.0)
setVehicleHandling(v, "driveType", "rwd")
setVehicleHandling(v, "engineType", "petrol")
setVehicleHandling(v, "brakeDeceleration", 20.0)
setVehicleHandling(v, "brakeBias", 0.60)
-----abs----
setVehicleHandling(v, "steeringLock", 35.0 )
setVehicleHandling(v, "suspensionForceLevel", 0.85)
setVehicleHandling(v, "suspensionDamping", 0.15 )
setVehicleHandling(v, "suspensionHighSpeedDamping", 0.0)
setVehicleHandling(v, "suspensionUpperLimit", 0.15 )
setVehicleHandling(v, "suspensionLowerLimit", -0.16)
setVehicleHandling(v, "suspensionFrontRearBias", 0.5 )
setVehicleHandling(v, "suspensionAntiDiveMultiplier", 0.0)
setVehicleHandling(v, "seatOffsetDistance", 0.0)
setVehicleHandling(v, "collisionDamageMultiplier", 0.00)
setVehicleHandling(v, "monetary", 10000)
setVehicleHandling(v, "modelFlags", 1002000)
setVehicleHandling(v, "handlingFlags", 1000002)
setVehicleHandling(v, "headLight", 3)
setVehicleHandling(v, "tailLight", 2)
setVehicleHandling(v, "animGroup", 4)
end
end
end
addEventHandler ( "onPlayerVehicleEnter", getRootElement(), vhandling )
</syntaxhighlight></section>

This example will add a command for players with which they can change the mass of the vehicle.
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function massChange ( me, command, mass )
local mass = tonumber ( mass ) -- Convert mass to a number
local veh = getPedOccupiedVehicle ( me ) -- Get the player's vehicle

if mass and veh then -- If valid mass and in a vehicle
local success = setVehicleHandling ( veh, "mass", mass) -- Set the vehicle's mass, and check if successful

if success then -- If successful
outputChatBox ( "Your vehicle's mass has been changed to: "..mass.." kg", me, 0, 255, 0 ) -- Notify the player of success
else -- Too bad failure is still an option
outputChatBox ( "Setting mass failed. It's probably above or below allowed limits", me, 255, 0, 0 ) -- Notify the player of failure, and give a possible reason
end
elseif not veh then -- If not in a vehicle
outputChatBox ( "You're not in a vehicle", me, 255, 0, 0 ) -- Tell the player; He / she obviously doesn't know
elseif not mass then -- If not a valid mass
outputChatBox ( "Syntax: /changemass [mass]", me, 255, 0, 0 ) -- Tell the player the proper syntax
end
end
addCommandHandler ( "changemass", massChange )
</syntaxhighlight></section>

This example will apply custom handling as defined for each specific vehicle (ID) in below table
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
local predefinedHandling = {
[411] = {
["engineAcceleration"] = 14,
["dragCoeff"] = 0,
["maxVelocity"] = 100000,
["tractionMultiplier"] = 0.9,
["tractionLoss"] = 1.1,
},
[415] = {
["engineAcceleration"] = 14,
["dragCoeff"] = 0,
["maxVelocity"] = 100000,
["tractionMultiplier"] = 0.9,
["tractionLoss"] = 1.1,
},
[562] = { -- Universal drift handling
["driveType"] = "rwd",
["engineAcceleration"] = 200,
["dragCoeff"] = 1.5,
["maxVelocity"] = 300,
["tractionMultiplier"] = 0.7,
["tractionLoss"] = 0.8,
["collisionDamageMultiplier"] = 0.4,
["engineInertia"] = -175,
["steeringLock"] = 75,
["numberOfGears"] = 4,
["suspensionForceLevel"] = 0.8,
["suspensionDamping"] = 0.8,
["suspensionUpperLimit"] = 0.33,
["suspensionFrontRearBias"] = 0.3,
["mass"] = 1800,
["turnMass"] = 3000,
["centerOfMass"] = { [1]=0, [2]=-0.2, [3]=-0.5 }, -- Good example to understand centerOfMass parameter usage
},

--next model below etc (copy rows)
}

for i,v in pairs (predefinedHandling) do
if i then
for handling, value in pairs (v) do
if not setModelHandling (i, handling, value) then
outputDebugString ("* Predefined handling '"..tostring(handling).."' for vehicle model '"..tostring(i).."' could not be set to '"..tostring(value).."'")
end
end
end
end

for _,v in ipairs (getElementsByType("vehicle")) do
if v and predefinedHandling[getElementModel(v)] then
for k,vl in pairs (predefinedHandling[getElementModel(v)]) do
setVehicleHandling (v, k, vl)
end
end
end

function resetHandling()
for model in pairs (predefinedHandling) do
if model then
for k in pairs(getOriginalHandling(model)) do
setModelHandling(model, k, nil)
end
end
end

for _,v in ipairs (getElementsByType("vehicle")) do
if v then
local model = getElementModel(v)
if predefinedHandling[model] then
for k,h in pairs(getOriginalHandling(model)) do
setVehicleHandling(v, k, h)
end
end
end
end
end
addEventHandler("onResourceStop", resourceRoot, resetHandling)
</syntaxhighlight></section>

==See other vehicle functions==
{{Vehicle functions}}

EngineRestoreAnimation

2018-06-22T21:20:18Z

Saml1er: Changed 1.5.6 to 1.5.5 for version transclusion

__NOTOC__
{{Client function}}
{{New items|3.0156|1.5.5|
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 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.
|12213}}
==Syntax==
<syntaxhighlight lang="lua">
bool engineRestoreAnimation ( ped thePed [, string InternalBlockName, string InternalAnimName ] )
</syntaxhighlight>

===Required Arguments===
*'''thePed:''' the [[player]] or [[ped]] you want to restore an animation(s) for.

===Optional Arguments===
{{OptionalArg}}
*'''InternalBlockName:''' the [[Animations|internal block]] name.
*'''InternalAnimName:''' the [[Animations|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.
<section name="client.lua" class="client" show="true">
<syntaxhighlight lang="lua">
engineRestoreAnimation ( localPlayer )
</syntaxhighlight>
</section>
'''Example 2:''' This example restores all replaced animations only within "ped" block for the local player.
<section name="client.lua" class="client" show="true">
<syntaxhighlight lang="lua">
engineRestoreAnimation ( localPlayer, "ped" )
</syntaxhighlight>
</section>
'''Example 3:''' This example restores "weapon_crouch" animation within "ped" block for the local player.
<section name="client.lua" class="client" show="true">
<syntaxhighlight lang="lua">
engineRestoreAnimation ( localPLayer, "ped", "weapon_crouch" )
</syntaxhighlight>
</section>

==See Also==
{{Engine_functions}}

EngineReplaceAnimation

2018-06-22T21:19:56Z

Saml1er: Changed 1.5.6 to 1.5.5 for version transclusion

__NOTOC__
{{Client function}}
{{New items|3.0156|1.5.5|
This function replaces a specific internal (default) animation with a custom one that has been loaded using [[EngineLoadIFP|engineLoadIFP]] function. This function only affects a specific [[player]] or [[ped]], the [[Animations|internal animation]] is not replaced for everyone, for instance, different players and peds are able to have completely different crouching, walking, and fighting etc., animations running simultaneously at the same time. Also, it's not synchronized, you'll need to execute this function on every client in Lua to synchronize it.

Internal animations replaced using this function can still be played with [[SetPedAnimation|setPedAnimation]]. You can restore replaced animations back with [[EngineRestoreAnimation|engineRestoreAnimation]].

It should be noted that partial animations are not supported, you can still replace them, but they won't work as intended, for example, "FightA_block" animation from "ped" block is a partial animation, you can't replace it properly, only a few animations are partial, rest of them are not, so it shouldn't be a problem.
|12213}}
==Syntax==
<syntaxhighlight lang="lua">
bool engineReplaceAnimation ( ped thePed, string InternalBlockName, string InternalAnimName, string CustomBlockName, string CustomAnimName )
</syntaxhighlight>

===Required Arguments===
*'''thePed:''' the [[player]] or [[ped]] you want to replace an animation for.
*'''InternalBlockName:''' the [[Animations|internal block]] name.
*'''InternalAnimName:''' the [[Animations|internal animation]] name inside InternalBlockName.
*'''CustomBlockName:''' the custom block name of the loaded IFP file that you passed to [[EngineLoadIFP|engineLoadIFP]] as second parameter.
*'''CustomAnimName:''' the custom animation name inside the loaded IFP file with CustomBlockName.
===Returns===
Returns ''true'' on success, ''false'' in case of failure.

==Example==
'''Example 1:''' This example loads a custom IFP file ([https://drive.google.com/file/d/1XZNNCCn7xhBNbhaIbsBubky3BEj06zWp/view?usp=sharing parkour.ifp]), and replaces the internal crouch animation from ped block with a custom animation. If you press C on your keyboard, the custom animation will be played instead of crouch animation.
<section name="client.lua" class="client" show="true">
<syntaxhighlight lang="lua">
--[[
credits to Paul_Cortez for the IFP file.
parkour.ifp has following animations:

BckHndSpingBTuck
BckHndSping
CartWheel
FrntHndSpring
HandPlant
]]

-- you can choose any name you want, do not choose a default GTA:SA block name
local customBlockName = "myNewBlock"

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

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

-- replace the crouch animation
engineReplaceAnimation ( localPlayer, "ped", "weapon_crouch", customBlockName, "HandPlant" )
</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>
</section>

==See Also==
{{Engine_functions}}

EngineLoadIFP

2018-06-22T21:19:22Z

Saml1er: Changed 1.5.6 to 1.5.5 for version transclusion

{{Client function}}
__NOTOC__
{{New items|3.0156|1.5.5|
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.
|12213}}
==Syntax==
<syntaxhighlight lang="lua">
ifp engineLoadIFP ( string IfpFilePath, string CustomBlockName )
</syntaxhighlight>

===Required Arguments===
*'''IfpFilePath:''' the [[filepath|file path]] to the IFP file you want to load.
*'''CustomBlockName:''' the new block name for the IFP file. You cannot use the GTA default [[Animations|internal block]] names.

===Returns===
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}}

==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.
<section name="client.lua" class="client" show="true">
<syntaxhighlight lang="lua">
--[[
credits to Paul_Cortez for the IFP file.
parkour.ifp has following animations:

BckHndSpingBTuck
BckHndSping
CartWheel
FrntHndSpring
HandPlant
]]

-- you can choose any name you want, do not choose a default GTA:SA block name
local customBlockName = "myNewBlock"

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

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

-- execute the command using /animation <NameOfCustomAnimation>
-- for example, /animation CartWheel
function setanimation ( commandName, animationName )
-- check if IFP file has loaded
if IFP then
-- now play our custom animation
setPedAnimation(localPlayer, customBlockName, animationName)
end
end
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>
</section>

==See Also==
{{Engine_functions}}

Template:Engine functions

2018-06-22T21:18:56Z

Saml1er: Changed 1.5.6 to 1.5.5 for version transclusion

* [[engineApplyShaderToWorldTexture]]
* [[engineGetModelIDFromName]]
* [[engineGetModelLODDistance]]
* [[engineGetModelNameFromID]]
* [[engineGetModelTextureNames]]
* [[engineGetVisibleTextureNames]]
* [[engineImportTXD]]
* [[engineLoadCOL]]
* [[engineLoadDFF]]
* [[engineLoadTXD]]
{{New items|3.0156|1.5.5|
* [[engineLoadIFP]]
* [[engineReplaceAnimation]]
* [[engineRestoreAnimation]]
|12213}}
* [[engineRemoveShaderFromWorldTexture]]
* [[engineReplaceCOL]]
* [[engineReplaceModel]]
* [[engineRestoreCOL]]
* [[engineRestoreModel]]
* [[engineSetAsynchronousLoading]]
* [[engineSetModelLODDistance]]

<noinclude>[[Category:Functions templates]]</noinclude>

EngineRestoreAnimation

2018-06-22T13:46:01Z

Saml1er: Added version transclusion

__NOTOC__
{{Client function}}
{{New items|3.0156|1.5.6|
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 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.
|12213}}
==Syntax==
<syntaxhighlight lang="lua">
bool engineRestoreAnimation ( ped thePed [, string InternalBlockName, string InternalAnimName ] )
</syntaxhighlight>

===Required Arguments===
*'''thePed:''' the [[player]] or [[ped]] you want to restore an animation(s) for.

===Optional Arguments===
{{OptionalArg}}
*'''InternalBlockName:''' the [[Animations|internal block]] name.
*'''InternalAnimName:''' the [[Animations|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.
<section name="client.lua" class="client" show="true">
<syntaxhighlight lang="lua">
engineRestoreAnimation ( localPlayer )
</syntaxhighlight>
</section>
'''Example 2:''' This example restores all replaced animations only within "ped" block for the local player.
<section name="client.lua" class="client" show="true">
<syntaxhighlight lang="lua">
engineRestoreAnimation ( localPlayer, "ped" )
</syntaxhighlight>
</section>
'''Example 3:''' This example restores "weapon_crouch" animation within "ped" block for the local player.
<section name="client.lua" class="client" show="true">
<syntaxhighlight lang="lua">
engineRestoreAnimation ( localPLayer, "ped", "weapon_crouch" )
</syntaxhighlight>
</section>

==See Also==
{{Engine_functions}}

EngineReplaceAnimation

2018-06-22T13:44:47Z

Saml1er: Added version transclusion

__NOTOC__
{{Client function}}
{{New items|3.0156|1.5.6|
This function replaces a specific internal (default) animation with a custom one that has been loaded using [[EngineLoadIFP|engineLoadIFP]] function. This function only affects a specific [[player]] or [[ped]], the [[Animations|internal animation]] is not replaced for everyone, for instance, different players and peds are able to have completely different crouching, walking, and fighting etc., animations running simultaneously at the same time. Also, it's not synchronized, you'll need to execute this function on every client in Lua to synchronize it.

Internal animations replaced using this function can still be played with [[SetPedAnimation|setPedAnimation]]. You can restore replaced animations back with [[EngineRestoreAnimation|engineRestoreAnimation]].

It should be noted that partial animations are not supported, you can still replace them, but they won't work as intended, for example, "FightA_block" animation from "ped" block is a partial animation, you can't replace it properly, only a few animations are partial, rest of them are not, so it shouldn't be a problem.
|12213}}
==Syntax==
<syntaxhighlight lang="lua">
bool engineReplaceAnimation ( ped thePed, string InternalBlockName, string InternalAnimName, string CustomBlockName, string CustomAnimName )
</syntaxhighlight>

===Required Arguments===
*'''thePed:''' the [[player]] or [[ped]] you want to replace an animation for.
*'''InternalBlockName:''' the [[Animations|internal block]] name.
*'''InternalAnimName:''' the [[Animations|internal animation]] name inside InternalBlockName.
*'''CustomBlockName:''' the custom block name of the loaded IFP file that you passed to [[EngineLoadIFP|engineLoadIFP]] as second parameter.
*'''CustomAnimName:''' the custom animation name inside the loaded IFP file with CustomBlockName.
===Returns===
Returns ''true'' on success, ''false'' in case of failure.

==Example==
'''Example 1:''' This example loads a custom IFP file ([https://drive.google.com/file/d/1XZNNCCn7xhBNbhaIbsBubky3BEj06zWp/view?usp=sharing parkour.ifp]), and replaces the internal crouch animation from ped block with a custom animation. If you press C on your keyboard, the custom animation will be played instead of crouch animation.
<section name="client.lua" class="client" show="true">
<syntaxhighlight lang="lua">
--[[
credits to Paul_Cortez for the IFP file.
parkour.ifp has following animations:

BckHndSpingBTuck
BckHndSping
CartWheel
FrntHndSpring
HandPlant
]]

-- you can choose any name you want, do not choose a default GTA:SA block name
local customBlockName = "myNewBlock"

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

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

-- replace the crouch animation
engineReplaceAnimation ( localPlayer, "ped", "weapon_crouch", customBlockName, "HandPlant" )
</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>
</section>

==See Also==
{{Engine_functions}}

EngineLoadIFP

2018-06-22T13:42:51Z

Saml1er: Added version transclusion

{{Client function}}
__NOTOC__
{{New items|3.0156|1.5.6|
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.
|12213}}
==Syntax==
<syntaxhighlight lang="lua">
ifp engineLoadIFP ( string IfpFilePath, string CustomBlockName )
</syntaxhighlight>

===Required Arguments===
*'''IfpFilePath:''' the [[filepath|file path]] to the IFP file you want to load.
*'''CustomBlockName:''' the new block name for the IFP file. You cannot use the GTA default [[Animations|internal block]] names.

===Returns===
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}}

==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.
<section name="client.lua" class="client" show="true">
<syntaxhighlight lang="lua">
--[[
credits to Paul_Cortez for the IFP file.
parkour.ifp has following animations:

BckHndSpingBTuck
BckHndSping
CartWheel
FrntHndSpring
HandPlant
]]

-- you can choose any name you want, do not choose a default GTA:SA block name
local customBlockName = "myNewBlock"

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

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

-- execute the command using /animation <NameOfCustomAnimation>
-- for example, /animation CartWheel
function setanimation ( commandName, animationName )
-- check if IFP file has loaded
if IFP then
-- now play our custom animation
setPedAnimation(localPlayer, customBlockName, animationName)
end
end
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>
</section>

==See Also==
{{Engine_functions}}

Template:Engine functions

2018-06-22T13:37:38Z

Saml1er: Added version transclusions to IFP functions

* [[engineApplyShaderToWorldTexture]]
* [[engineGetModelIDFromName]]
* [[engineGetModelLODDistance]]
* [[engineGetModelNameFromID]]
* [[engineGetModelTextureNames]]
* [[engineGetVisibleTextureNames]]
* [[engineImportTXD]]
* [[engineLoadCOL]]
* [[engineLoadDFF]]
* [[engineLoadTXD]]
{{New items|3.0156|1.5.6|
* [[engineLoadIFP]]
* [[engineReplaceAnimation]]
* [[engineRestoreAnimation]]
|12213}}
* [[engineRemoveShaderFromWorldTexture]]
* [[engineReplaceCOL]]
* [[engineReplaceModel]]
* [[engineRestoreCOL]]
* [[engineRestoreModel]]
* [[engineSetAsynchronousLoading]]
* [[engineSetModelLODDistance]]

<noinclude>[[Category:Functions templates]]</noinclude>

EngineLoadIFP

2018-06-22T10:20:34Z

Saml1er: Added a tip that links ifp_demo resource for animation synchronization

{{Client function}}
__NOTOC__
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.
==Syntax==
<syntaxhighlight lang="lua">
ifp engineLoadIFP ( string IfpFilePath, string CustomBlockName )
</syntaxhighlight>

===Required Arguments===
*'''IfpFilePath:''' the [[filepath|file path]] to the IFP file you want to load.
*'''CustomBlockName:''' the new block name for the IFP file. You cannot use the GTA default [[Animations|internal block]] names.

===Returns===
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}}

==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.
<section name="client.lua" class="client" show="true">
<syntaxhighlight lang="lua">
--[[
credits to Paul_Cortez for the IFP file.
parkour.ifp has following animations:

BckHndSpingBTuck
BckHndSping
CartWheel
FrntHndSpring
HandPlant
]]

-- you can choose any name you want, do not choose a default GTA:SA block name
local customBlockName = "myNewBlock"

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

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

-- execute the command using /animation <NameOfCustomAnimation>
-- for example, /animation CartWheel
function setanimation ( commandName, animationName )
-- check if IFP file has loaded
if IFP then
-- now play our custom animation
setPedAnimation(localPlayer, customBlockName, animationName)
end
end
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>
</section>

==See Also==
{{Engine_functions}}

SetVehicleHandling

2018-06-19T10:17:54Z

Saml1er: changed template from server function to Server client function

{{Server client function}}
__NOTOC__
This function is used to change the handling data of a vehicle.

==Syntax==
<syntaxhighlight lang="lua">
bool setVehicleHandling ( element theVehicle, string property, var value )
</syntaxhighlight>

Syntaxes for reset configurations:
<syntaxhighlight lang="lua">
bool setVehicleHandling ( element theVehicle, string property, nil, false ) -- Reset one property to model handling value
bool setVehicleHandling ( element theVehicle, string property, nil, true ) -- Reset one property to GTA default value
bool setVehicleHandling ( element theVehicle, false ) -- Reset all properties to model handling value
bool setVehicleHandling ( element theVehicle, true ) -- Reset all properties to GTA default value
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The vehicle you wish to set the handling of.
*'''property:''' The property you wish to set the handling of the vehicle to.
{{Handling Properties}}
*'''value:''' The value of the property you wish to set the handling of the vehicle to.

===Returns===
Returns ''true'' if the handling was set successfully, ''false'' otherwise. See below a list of valid properties and their required values:

==Notes==
for functionality reasons suspension modification is disabled on monster trucks, trains, boats and trailers.

==Example==
This example will make Infernus handling very fast and also make it damage proof from collision (handling by Mr.unpredictable).
this example will help you in creating your own vehicle Handling.
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function vhandling ( )
for _,v in pairs(getElementsByType("vehicle")) do
if getElementModel(v) == 411 then -------------- vehicle Id
setVehicleHandling (v, "mass", 300.0)
setVehicleHandling(v, "turnMass", 200)
setVehicleHandling(v, "dragCoeff", 4.0 )
setVehicleHandling(v, "centerOfMass", { 0.0,0.08,-0.09 } )
setVehicleHandling(v, "percentSubmerged", 103)
setVehicleHandling(v, "tractionMultiplier", 1.8)
setVehicleHandling(v, "tractionLoss", 1.0)
setVehicleHandling(v, "tractionBias", 0.48)
setVehicleHandling(v, "numberOfGears", 5)
setVehicleHandling(v, "maxVelocity", 300.0)
setVehicleHandling(v, "engineAcceleration", 90.0 )
setVehicleHandling(v, "engineInertia", 5.0)
setVehicleHandling(v, "driveType", "rwd")
setVehicleHandling(v, "engineType", "petrol")
setVehicleHandling(v, "brakeDeceleration", 20.0)
setVehicleHandling(v, "brakeBias", 0.60)
-----abs----
setVehicleHandling(v, "steeringLock", 35.0 )
setVehicleHandling(v, "suspensionForceLevel", 0.85)
setVehicleHandling(v, "suspensionDamping", 0.15 )
setVehicleHandling(v, "suspensionHighSpeedDamping", 0.0)
setVehicleHandling(v, "suspensionUpperLimit", 0.15 )
setVehicleHandling(v, "suspensionLowerLimit", -0.16)
setVehicleHandling(v, "suspensionFrontRearBias", 0.5 )
setVehicleHandling(v, "suspensionAntiDiveMultiplier", 0.0)
setVehicleHandling(v, "seatOffsetDistance", 0.0)
setVehicleHandling(v, "collisionDamageMultiplier", 0.00)
setVehicleHandling(v, "monetary", 10000)
setVehicleHandling(v, "modelFlags", 1002000)
setVehicleHandling(v, "handlingFlags", 1000002)
setVehicleHandling(v, "headLight", 3)
setVehicleHandling(v, "tailLight", 2)
setVehicleHandling(v, "animGroup", 4)
end
end
end
addEventHandler ( "onPlayerVehicleEnter", getRootElement(), vhandling )
</syntaxhighlight></section>

This example will add a command for players with which they can change the mass of the vehicle.
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function massChange ( me, command, mass )
local mass = tonumber ( mass ) -- Convert mass to a number
local veh = getPedOccupiedVehicle ( me ) -- Get the player's vehicle

if mass and veh then -- If valid mass and in a vehicle
local success = setVehicleHandling ( veh, "mass", mass) -- Set the vehicle's mass, and check if successful

if success then -- If successful
outputChatBox ( "Your vehicle's mass has been changed to: "..mass.." kg", me, 0, 255, 0 ) -- Notify the player of success
else -- Too bad failure is still an option
outputChatBox ( "Setting mass failed. It's probably above or below allowed limits", me, 255, 0, 0 ) -- Notify the player of failure, and give a possible reason
end
elseif not veh then -- If not in a vehicle
outputChatBox ( "You're not in a vehicle", me, 255, 0, 0 ) -- Tell the player; He / she obviously doesn't know
elseif not mass then -- If not a valid mass
outputChatBox ( "Syntax: /changemass [mass]", me, 255, 0, 0 ) -- Tell the player the proper syntax
end
end
addCommandHandler ( "changemass", massChange )
</syntaxhighlight></section>

This example will apply custom handling as defined for each specific vehicle (ID) in below table
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
local predefinedHandling = {
[411] = {
["engineAcceleration"] = 14,
["dragCoeff"] = 0,
["maxVelocity"] = 100000,
["tractionMultiplier"] = 0.9,
["tractionLoss"] = 1.1,
},
[415] = {
["engineAcceleration"] = 14,
["dragCoeff"] = 0,
["maxVelocity"] = 100000,
["tractionMultiplier"] = 0.9,
["tractionLoss"] = 1.1,
},
[562] = { -- Universal drift handling
["driveType"] = "rwd",
["engineAcceleration"] = 200,
["dragCoeff"] = 1.5,
["maxVelocity"] = 300,
["tractionMultiplier"] = 0.7,
["tractionLoss"] = 0.8,
["collisionDamageMultiplier"] = 0.4,
["engineInertia"] = -175,
["steeringLock"] = 75,
["numberOfGears"] = 4,
["suspensionForceLevel"] = 0.8,
["suspensionDamping"] = 0.8,
["suspensionUpperLimit"] = 0.33,
["suspensionFrontRearBias"] = 0.3,
["mass"] = 1800,
["turnMass"] = 3000,
["centerOfMass"] = { [1]=0, [2]=-0.2, [3]=-0.5 }, -- Good example to understand centerOfMass parameter usage
},

--next model below etc (copy rows)
}

for i,v in pairs (predefinedHandling) do
if i then
for handling, value in pairs (v) do
if not setModelHandling (i, handling, value) then
outputDebugString ("* Predefined handling '"..tostring(handling).."' for vehicle model '"..tostring(i).."' could not be set to '"..tostring(value).."'")
end
end
end
end

for _,v in ipairs (getElementsByType("vehicle")) do
if v and predefinedHandling[getElementModel(v)] then
for k,vl in pairs (predefinedHandling[getElementModel(v)]) do
setVehicleHandling (v, k, vl)
end
end
end

function resetHandling()
for model in pairs (predefinedHandling) do
if model then
for k in pairs(getOriginalHandling(model)) do
setModelHandling(model, k, nil)
end
end
end

for _,v in ipairs (getElementsByType("vehicle")) do
if v then
local model = getElementModel(v)
if predefinedHandling[model] then
for k,h in pairs(getOriginalHandling(model)) do
setVehicleHandling(v, k, h)
end
end
end
end
end
addEventHandler("onResourceStop", resourceRoot, resetHandling)
</syntaxhighlight></section>

==See other vehicle functions==
{{Vehicle functions}}

Template:Engine functions

2018-06-18T22:20:43Z

Saml1er: Added new IFP engine functions to Engine_functions template

* [[engineApplyShaderToWorldTexture]]
* [[engineGetModelIDFromName]]
* [[engineGetModelLODDistance]]
* [[engineGetModelNameFromID]]
* [[engineGetModelTextureNames]]
* [[engineGetVisibleTextureNames]]
* [[engineImportTXD]]
* [[engineLoadCOL]]
* [[engineLoadDFF]]
* [[engineLoadTXD]]
* [[engineLoadIFP]]
* [[engineRemoveShaderFromWorldTexture]]
* [[engineReplaceCOL]]
* [[engineReplaceModel]]
* [[engineReplaceAnimation]]
* [[engineRestoreCOL]]
* [[engineRestoreModel]]
* [[engineRestoreAnimation]]
* [[engineSetAsynchronousLoading]]
* [[engineSetModelLODDistance]]

<noinclude>[[Category:Functions templates]]</noinclude>

EngineRestoreAnimation

2018-06-18T21:34:19Z

Saml1er: Added examples, and separated optional arguments from required

__NOTOC__
{{Client function}}
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 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==
<syntaxhighlight lang="lua">
bool engineRestoreAnimation ( ped thePed [, string InternalBlockName, string InternalAnimName ] )
</syntaxhighlight>

===Required Arguments===
*'''thePed:''' the [[player]] or [[ped]] you want to restore an animation(s) for.

===Optional Arguments===
{{OptionalArg}}
*'''InternalBlockName:''' the [[Animations|internal block]] name.
*'''InternalAnimName:''' the [[Animations|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.
<section name="client.lua" class="client" show="true">
<syntaxhighlight lang="lua">
engineRestoreAnimation ( localPlayer )
</syntaxhighlight>
</section>
'''Example 2:''' This example restores all replaced animations only within "ped" block for the local player.
<section name="client.lua" class="client" show="true">
<syntaxhighlight lang="lua">
engineRestoreAnimation ( localPlayer, "ped" )
</syntaxhighlight>
</section>
'''Example 3:''' This example restores "weapon_crouch" animation within "ped" block for the local player.
<section name="client.lua" class="client" show="true">
<syntaxhighlight lang="lua">
engineRestoreAnimation ( localPLayer, "ped", "weapon_crouch" )
</syntaxhighlight>
</section>

==See Also==
{{Engine_functions}}

EngineLoadIFP

2018-06-18T21:19:01Z

Saml1er: Fixed typo in file name

{{Client function}}
__NOTOC__
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.
==Syntax==
<syntaxhighlight lang="lua">
ifp engineLoadIFP ( string IfpFilePath, string CustomBlockName )
</syntaxhighlight>

===Required Arguments===
*'''IfpFilePath:''' the [[filepath|file path]] to the IFP file you want to load.
*'''CustomBlockName:''' the new block name for the IFP file. You cannot use the GTA default [[Animations|internal block]] names.

===Returns===
Returns an [[IFP]] element if the IFP file loaded, ''false'' otherwise.

==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.
<section name="client.lua" class="client" show="true">
<syntaxhighlight lang="lua">
--[[
credits to Paul_Cortez for the IFP file.
parkour.ifp has following animations:

BckHndSpingBTuck
BckHndSping
CartWheel
FrntHndSpring
HandPlant
]]

-- you can choose any name you want, do not choose a default GTA:SA block name
local customBlockName = "myNewBlock"

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

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

-- execute the command using /animation <NameOfCustomAnimation>
-- for example, /animation CartWheel
function setanimation ( commandName, animationName )
-- check if IFP file has loaded
if IFP then
-- now play our custom animation
setPedAnimation(localPlayer, customBlockName, animationName)
end
end
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>
</section>

==See Also==
{{Engine_functions}}

EngineReplaceAnimation

2018-06-18T21:18:22Z

Saml1er: Fixed typo in file name

__NOTOC__
{{Client function}}
This function replaces a specific internal (default) animation with a custom one that has been loaded using [[EngineLoadIFP|engineLoadIFP]] function. This function only affects a specific [[player]] or [[ped]], the [[Animations|internal animation]] is not replaced for everyone, for instance, different players and peds are able to have completely different crouching, walking, and fighting etc., animations running simultaneously at the same time. Also, it's not synchronized, you'll need to execute this function on every client in Lua to synchronize it.

Internal animations replaced using this function can still be played with [[SetPedAnimation|setPedAnimation]]. You can restore replaced animations back with [[EngineRestoreAnimation|engineRestoreAnimation]].

It should be noted that partial animations are not supported, you can still replace them, but they won't work as intended, for example, "FightA_block" animation from "ped" block is a partial animation, you can't replace it properly, only a few animations are partial, rest of them are not, so it shouldn't be a problem.

==Syntax==
<syntaxhighlight lang="lua">
bool engineReplaceAnimation ( ped thePed, string InternalBlockName, string InternalAnimName, string CustomBlockName, string CustomAnimName )
</syntaxhighlight>

===Required Arguments===
*'''thePed:''' the [[player]] or [[ped]] you want to replace an animation for.
*'''InternalBlockName:''' the [[Animations|internal block]] name.
*'''InternalAnimName:''' the [[Animations|internal animation]] name inside InternalBlockName.
*'''CustomBlockName:''' the custom block name of the loaded IFP file that you passed to [[EngineLoadIFP|engineLoadIFP]] as second parameter.
*'''CustomAnimName:''' the custom animation name inside the loaded IFP file with CustomBlockName.
===Returns===
Returns ''true'' on success, ''false'' in case of failure.

==Example==
'''Example 1:''' This example loads a custom IFP file ([https://drive.google.com/file/d/1XZNNCCn7xhBNbhaIbsBubky3BEj06zWp/view?usp=sharing parkour.ifp]), and replaces the internal crouch animation from ped block with a custom animation. If you press C on your keyboard, the custom animation will be played instead of crouch animation.
<section name="client.lua" class="client" show="true">
<syntaxhighlight lang="lua">
--[[
credits to Paul_Cortez for the IFP file.
parkour.ifp has following animations:

BckHndSpingBTuck
BckHndSping
CartWheel
FrntHndSpring
HandPlant
]]

-- you can choose any name you want, do not choose a default GTA:SA block name
local customBlockName = "myNewBlock"

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

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

-- replace the crouch animation
engineReplaceAnimation ( localPlayer, "ped", "weapon_crouch", customBlockName, "HandPlant" )
</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>
</section>

==See Also==
{{Engine_functions}}

EngineReplaceAnimation

2018-06-18T21:15:54Z

Saml1er: /* Example */

__NOTOC__
{{Client function}}
This function replaces a specific internal (default) animation with a custom one that has been loaded using [[EngineLoadIFP|engineLoadIFP]] function. This function only affects a specific [[player]] or [[ped]], the [[Animations|internal animation]] is not replaced for everyone, for instance, different players and peds are able to have completely different crouching, walking, and fighting etc., animations running simultaneously at the same time. Also, it's not synchronized, you'll need to execute this function on every client in Lua to synchronize it.

Internal animations replaced using this function can still be played with [[SetPedAnimation|setPedAnimation]]. You can restore replaced animations back with [[EngineRestoreAnimation|engineRestoreAnimation]].

It should be noted that partial animations are not supported, you can still replace them, but they won't work as intended, for example, "FightA_block" animation from "ped" block is a partial animation, you can't replace it properly, only a few animations are partial, rest of them are not, so it shouldn't be a problem.

==Syntax==
<syntaxhighlight lang="lua">
bool engineReplaceAnimation ( ped thePed, string InternalBlockName, string InternalAnimName, string CustomBlockName, string CustomAnimName )
</syntaxhighlight>

===Required Arguments===
*'''thePed:''' the [[player]] or [[ped]] you want to replace an animation for.
*'''InternalBlockName:''' the [[Animations|internal block]] name.
*'''InternalAnimName:''' the [[Animations|internal animation]] name inside InternalBlockName.
*'''CustomBlockName:''' the custom block name of the loaded IFP file that you passed to [[EngineLoadIFP|engineLoadIFP]] as second parameter.
*'''CustomAnimName:''' the custom animation name inside the loaded IFP file with CustomBlockName.
===Returns===
Returns ''true'' on success, ''false'' in case of failure.

==Example==
'''Example 1:''' This example loads a custom IFP file ([https://drive.google.com/file/d/1XZNNCCn7xhBNbhaIbsBubky3BEj06zWp/view?usp=sharing parkour.ifp]), and replaces the internal crouch animation from ped block with a custom animation. If you press C on your keyboard, the custom animation will be played instead of crouch animation.
<section name="animation.lua" class="client" show="true">
<syntaxhighlight lang="lua">
--[[
credits to Paul_Cortez for the IFP file.
parkour.ifp has following animations:

BckHndSpingBTuck
BckHndSping
CartWheel
FrntHndSpring
HandPlant
]]

-- you can choose any name you want, do not choose a default GTA:SA block name
local customBlockName = "myNewBlock"

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

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

-- replace the crouch animation
engineReplaceAnimation ( localPlayer, "ped", "weapon_crouch", customBlockName, "HandPlant" )
</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>
</section>

==See Also==
{{Engine_functions}}

EngineLoadIFP

2018-06-18T21:09:18Z

Saml1er: used a variable instead of passing a raw string

{{Client function}}
__NOTOC__
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.
==Syntax==
<syntaxhighlight lang="lua">
ifp engineLoadIFP ( string IfpFilePath, string CustomBlockName )
</syntaxhighlight>

===Required Arguments===
*'''IfpFilePath:''' the [[filepath|file path]] to the IFP file you want to load.
*'''CustomBlockName:''' the new block name for the IFP file. You cannot use the GTA default [[Animations|internal block]] names.

===Returns===
Returns an [[IFP]] element if the IFP file loaded, ''false'' otherwise.

==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.
<section name="animation.lua" class="client" show="true">
<syntaxhighlight lang="lua">
--[[
credits to Paul_Cortez for the IFP file.
parkour.ifp has following animations:

BckHndSpingBTuck
BckHndSping
CartWheel
FrntHndSpring
HandPlant
]]

-- you can choose any name you want, do not choose a default GTA:SA block name
local customBlockName = "myNewBlock"

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

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

-- execute the command using /animation <NameOfCustomAnimation>
-- for example, /animation CartWheel
function setanimation ( commandName, animationName )
-- check if IFP file has loaded
if IFP then
-- now play our custom animation
setPedAnimation(localPlayer, customBlockName, animationName)
end
end
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>
</section>

==See Also==
{{Engine_functions}}

EngineUnloadIFP

2018-06-18T21:04:23Z

Saml1er:

{{Client function}}
{{Disabled|Function disabled. It doesn't exist anymore, use [[DestroyElement|destroyElement]] to unload IFP.}}
__NOTOC__
This function unloads an animation library loaded by [[engineLoadIFP]].

==Syntax==
<syntaxhighlight lang="lua">
bool engineLoadIFP ( element ifp )
</syntaxhighlight>

===Required Arguments===
*'''ifp:''' The IFP [[element]] loaded by [[engineLoadIFP]] to unload.

===Returns===
Returns ''true'' if the IFP file has been unloaded succesfully, ''false'' otherwise.

==Example==
<section name="animation.lua" class="client" show="true">
<syntaxhighlight lang="lua">
local localPlayer = getLocalPlayer()
local ifp = nil

function setanimation()
ifp = engineLoadIFP("data/ani.ifp")
if ifp then
setPedAnimation(localPlayer, "ANIMATIONBLOCK", "animation1")
end
end

addCommandHandler("animation", setanimation)

function stopanimation()
if ifp then
engineUnloadIFP(ifp)
setPedAnimation(localPlayer)
end
end

addCommandHandler("stopanimation", stopanimation)
</syntaxhighlight>
</section>
<section name="meta.xml" class="server" show="true">
<syntaxhighlight lang="lua">
<meta>
<info author="lukry" version="1.0" type="script" />
<script src="animation.lua" type="client" />
<file src="data/ani.ifp" />
</meta>
</syntaxhighlight>
</section>

==See Also==
{{Engine_functions}}

EngineReplaceAnimation

2018-06-18T20:51:05Z

Saml1er:

EngineRestoreAnimation

2018-06-18T20:49:45Z

Saml1er: Created page with "__NOTOC__ {{Client function}} This function restores internal (default) animations that were replaced using engineReplaceAnimation function. This fu..."

EngineLoadIFP

2018-06-18T19:55:31Z

Saml1er: Updated engineLoadIFP with latest syntax and example.

{{Client function}}
__NOTOC__
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.
==Syntax==
<syntaxhighlight lang="lua">
ifp engineLoadIFP ( string IfpFilePath, string CustomBlockName )
</syntaxhighlight>

===Required Arguments===
*'''IfpFilePath:''' the [[filepath|file path]] to the IFP file you want to load.
*'''CustomBlockName:''' the new block name for the IFP file. You cannot use the GTA default [[Animations|internal block]] names.

===Returns===
Returns an [[IFP]] element if the IFP file loaded, ''false'' otherwise.

==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.
<section name="animation.lua" class="client" show="true">
<syntaxhighlight lang="lua">
--[[
credits to Paul_Cortez for the IFP file.
parkour.ifp has following animations:

BckHndSpingBTuck
BckHndSping
CartWheel
FrntHndSpring
HandPlant
]]

-- you can choose any name you want, do not choose a default GTA:SA block name
local customBlockName = "myNewBlock"

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

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

-- execute the command using /animation <NameOfCustomAnimation>
-- for example, /animation CartWheel
function setanimation ( commandName, animationName )
-- check if IFP file has loaded
if IFP then
-- now play our custom animation
setPedAnimation(localPlayer, customBlockName, animationName)
end
end
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>
</section>

==See Also==
{{Engine_functions}}

EngineLoadIFP

2018-06-18T18:53:05Z

Saml1er:

EngineLoadIFP

2018-06-18T18:47:39Z

Saml1er: