Multi Theft Auto: Wiki - User contributions [en]

FxAddTankFire

2012-05-25T13:11:28Z

Mehmet Soedir: /* Example */

__NOTOC__
{{Client function}}
[[Image:Fxtankfire.png|thumb|200px|Tank fire]]
This function creates a tank firing particle effect.

==Syntax==
<syntaxhighlight lang="lua">
bool fxAddTankFire ( float posX, float posY, float posZ, float dirX, float dirY, float dirZ )
</syntaxhighlight>

===Required Arguments===
*'''posX, posY, posZ:''' the world coordinates where the effect originates.
*'''dirX, dirY, dirZ:''' a direction vector indicating where the tank fire is directed to.

===Returns===
Returns a true if the operation was successful, false otherwise.

==Example==
<section name="Client" class="client" show="true">
This example will create a Tank Fire Effect at your weapon's muzzle position

<syntaxhighlight lang="lua">
addEventHandler("onClientPlayerWeaponFire", root, function(weapon, ammo, ammoInClip, hitX, hitY, hitZ, hitElement)
if weapon == 0 then return end -- If the player is unarmed, return end.
local mX, mY, mZ = getPedWeaponMuzzlePosition(localPlayer)
fxAddTankFire(mX, mY, mZ, 0, 90, 0)
end)
</syntaxhighlight>
</section>

==See Also==
{{Client Effects functions}}

FxAddWaterSplash

2012-05-25T13:01:05Z

Mehmet Soedir: /* Example */

__NOTOC__
{{Client function}}
[[Image:Fxwatersplash.png|thumb|200px|Water splash]]
This function creates a water splash particle effect.

==Syntax==
<syntaxhighlight lang="lua">
bool fxAddWaterSplash ( float posX, float posY, float posZ )
</syntaxhighlight>

===Required Arguments===
* '''posX:''' A float representing the '''x''' position of the splash
* '''posY:''' A float representing the '''y''' position of the splash
* '''posZ:''' A float representing the '''z''' position of the splash

===Returns===
Returns a true if the operation was successful, false otherwise.

==Example==
<section name="Client" class="client" show="true">
This example will create a Water Splash at the position of the bullet impact whenever you shoot.

<syntaxhighlight lang="lua">
addEventHandler("onClientPlayerWeaponFire", root, function(weapon, ammo, ammoInClip, hitX, hitY, hitZ, hitElement)
if weapon == 0 then return end -- If the player is unarmed, return end.
fxAddWaterSplash(hitX, hitY, hitZ)
end)
</syntaxhighlight>
</section>

==See Also==
{{Client Effects functions}}

FxAddFootSplash

2012-05-25T12:58:23Z

Mehmet Soedir: /* Example */

__NOTOC__
{{Client function}}
[[Image:Fxfootsplash.png|thumb|200px|Foot splash]]
This function creates a foot splash particle effect, normally created when walking into water.

==Syntax==
<syntaxhighlight lang="lua">
bool fxAddFootSplash ( float posX, float posY, float posZ )
</syntaxhighlight>

===Required Arguments===
* '''posX:''' A float representing the '''x''' position of the splash
* '''posY:''' A float representing the '''y''' position of the splash
* '''posZ:''' A float representing the '''z''' position of the splash

===Returns===
Returns a true if the operation was successful, false otherwise.

==Example==
<section name="Client" class="client" show="true">
This example will create a Foot Splash at the position of the bullet impact whenever you shoot.

<syntaxhighlight lang="lua">
addEventHandler("onClientPlayerWeaponFire", root, function(weapon, ammo, ammoInClip, hitX, hitY, hitZ, hitElement)
if weapon == 0 then return end -- If the player is unarmed, return end.
fxAddFootSplash(hitX, hitY, hitZ)
end)
</syntaxhighlight>
</section>

==See Also==
{{Client Effects functions}}

FxAddWood

2012-05-25T12:48:44Z

Mehmet Soedir: /* Example */

__NOTOC__
{{Client function}}
[[Image:Fxwood.png|thumb|200px|Wood]]
Creates a wood splinter particle effect.

==Syntax==
<syntaxhighlight lang="lua">
bool fxAddWood ( float posX, float posY, float posZ, float dirX, float dirY, float dirZ, [int count=1, float brightness=1.0] )
</syntaxhighlight>

===Required Arguments===
*'''posX, posY, posZ:''' the world coordinates where the effect originates.
*'''dirX, dirY, dirZ:''' a direction vector indicating where the wood splinters fly to.

===Optional Arguments===
{{OptionalArg}}
*'''count:''' the number of splinters to create.
*'''brightness:''' the brightness. Ranges from 0 (black) to 1 (normal color).

===Returns===
Returns a true if the operation was successful, false otherwise.

==Example==
<section name="Client" class="client" show="true">
This example will create a Wood Effect next to you when typing ''/woodfx'' in the Chatbox.

<syntaxhighlight lang="lua">
addCommandHandler("woodfx", function()
local x, y, z = getElementPosition(localPlayer)
local gz = getGroundPosition(x, y, z)
fxAddWood(x, y, gz+0.4, 0, 0, 0, math.random(3, 6), 0.7)
end)
</syntaxhighlight>
</section>

==See Also==
{{Client Effects functions}}

FxAddTyreBurst

2012-05-25T12:41:49Z

Mehmet Soedir: /* Example */

__NOTOC__
{{Client function}}
[[Image:Fxtyreburst.png|thumb|200px|Tyre burst]]
Creates a tyre burst particle effect (a small white smoke puff).

==Syntax==
<syntaxhighlight lang="lua">
bool fxAddTyreBurst ( float posX, float posY, float posZ, float dirX, float dirY, float dirZ )
</syntaxhighlight>

===Required Arguments===
*'''posX, posY, posZ:''' the world coordinates where the puff originates.
*'''dirX, dirY, dirZ:''' a vector indicating the movement direction of the effect.

===Returns===
Returns a true if the operation was successful, false otherwise.

==Example==
<section name="Client" class="client" show="true">
This example will create a Tyre Burst Effect next to you when typing ''/tyreburst'' in the Chatbox.

<syntaxhighlight lang="lua">
addCommandHandler("tyreburst", function()
local x, y, z = getElementPosition(localPlayer)
local gz = getGroundPosition(x, y, z)
fxAddTyreBurst(x, y, gz, 0, 0, 0)
end)
</syntaxhighlight>
</section>

==See Also==
{{Client Effects functions}}

FxAddSparks

2012-05-25T12:30:00Z

Mehmet Soedir: /* Example */ Huge Example

__NOTOC__
{{Client function}}
[[Image:Fxsparks.png|thumb|200px|Sparks]]
Creates a number of sparks originating from a point or along a line.

==Syntax==
<syntaxhighlight lang="lua">
bool fxAddSparks ( float posX, float posY, float posZ, float dirX, float dirY, float dirZ, [float force=1, int count=1,
float acrossLineX=0, float acrossLineY=0, float acrossLineZ=0, bool blur=false, float spread=1, float life=1] )
</syntaxhighlight>

===Required Arguments===
*'''posX, posY, posZ:''' the world coordinates where the sparks originate.
*'''dirX, dirY, dirZ:''' a direction vector indicating where the sparks fly to. The longer this vector is, the faster the sparks fly.

===Optional Arguments===
{{OptionalArg}}
*'''force:''' speed factor: the higher this value, the faster and further the sparks fly.
*'''count:''' the number of effects to create.
*'''acrossLineX, acrossLineY, acrossLineZ:''' a vector starting at the '''pos''' coordinates. If specified, the sparks will be created along a line going from '''pos''' to '''pos - acrossLine'''. If not specified, all sparks originate from the point at '''pos'''.
*'''blur:''' if ''false'', creates standard bullet impact-like sparks. If ''true'', adds motion blur to the sparks.
*'''spread:''' determines how strongly the particles deviate from each other. With low values the particles will stay quite close together, high values will make them fly in all directions. Also affects their speed.
*'''life:''' the higher this value, the longer the sparks survive before they disappear.

===Returns===
Returns a true if the operation was successful, false otherwise.

==Example==
<section name="Client" class="client" show="true">
This example will add Fire Bins to all locations added in the table.

<syntaxhighlight lang="lua">
fires = {
{0, 0, 3} --Middle of SA
}

for i = 1, #fires do
bin = createObject(1362, fires[i][1], fires[i][2], fires[i][3]-0.5)
torch = createObject(3461, fires[i][1]-0.1, fires[i][2]-0.1, fires[i][3]-2)
light = createMarker(fires[i][1], fires[i][2], fires[i][3]+0.2, "corona", 1, 255, 170, 0, 80, root)
fireCol = createColSphere(fires[i][1], fires[i][2], fires[i][3]+0.5, 0.8)
setTimer(fxAddSparks, math.random(4000, 5000), 0, fires[i][1]+math.random(0.1, 0.3), fires[i][2]+math.random(0.1, 0.2), fires[i][3]+0.2, 1, 1, 1)

addEventHandler("onClientColShapeHit", fireCol,
function(theElement)
if (getElementType(theElement) == "player") then
setPedOnFire(theElement, true)
end
end)

end
</syntaxhighlight>
</section>

==See Also==
{{Client Effects functions}}

FxAddPunchImpact

2012-05-25T12:21:47Z

Mehmet Soedir: /* Example */

__NOTOC__
{{Client function}}
[[Image:Fxpunchimpact.png|thumb|200px|Punch impact]]
Creates a punch impact particle effect (a small dust cloud).

==Syntax==
<syntaxhighlight lang="lua">
bool fxAddPunchImpact ( float posX, float posY, float posZ, float dirX, float dirY, float dirZ )
</syntaxhighlight>

===Required Arguments===
*'''posX, posY, posZ:''' the world coordinates where the effect originates.
*'''dirX, dirY, dirZ:''' a vector indicating the movement direction of the effect.

===Returns===
Returns a true if the operation was successful, false otherwise.

==Example==
<section name="Client" class="client" show="true">
This example will create a Punch Impact Effect next to you when typing ''/pimpact'' in the Chatbox.
<syntaxhighlight lang="lua">
addCommandHandler("pimpact", function()
local x, y, z = getElementPosition(localPlayer)
local gz = getGroundPosition(x, y, z)
fxAddPunchImpact(x, y, gz, 0, 0, 0)
end)
</syntaxhighlight>
</section>

==See Also==
{{Client Effects functions}}

FxAddGlass

2012-05-25T12:14:13Z

Mehmet Soedir: Cleaned up examples

__NOTOC__
{{Client function}}
[[Image:Fxglass.png|thumb|200px|Glass]]
This function creates a glass particle effect.

==Syntax==
<syntaxhighlight lang="lua">
bool fxAddGlass ( float posX, float posY, float posZ, [int colorR=255, int colorG=0, int colorB=0, int colorA=255, float scale=1.0, int count=1] )
</syntaxhighlight>

===Required Arguments===
* '''posX:''' A float representing the '''x''' position of the glass
* '''posY:''' A float representing the '''y''' position of the glass
* '''posZ:''' A float representing the '''z''' position of the glass

===Optional Arguments===
{{OptionalArg}}
*'''colorR, colorG, colorB, colorA:''' the color and alpha (transparency) of the glass effect.
* '''scale:''' A float representing the size of the particle effect, where '''1''' is the standard size.
* '''count:''' The density of the particle effect.

===Returns===
Returns a true if the operation was successful, false otherwise.

==Examples==

<section name="Client" class="client" show="true">
This example shows you how to add a command to add glass effect.
<syntaxhighlight lang="lua">function addGlassParticle(r,g,b,a,scale,count)
x,y,z = getElementPosition(localPlayer)
fxAddGlass(x+3,y,z,r,g,b,a,scale,count)
end
addCommandHandler("addGlass",addGlassParticle)
</syntaxhighlight>
</section>

<section name="Client" class="client" show="true">
This example shows you how to add a glass effect to a map
<syntaxhighlight lang="lua">
function addPG()
fxAddGlass(0,0,0,134,231,231,1,random(30,40))
end
addEventHandler("onResourceStart",getResourceRootElement(getThisResource(), addPG)
</syntaxhighlight>
</section>

==See Also==
{{Client Effects functions}}

FxAddDebris

2012-05-25T12:11:28Z

Mehmet Soedir: Removed from 'Needs Example' list

__NOTOC__
{{Client function}}
[[Image:Fxdebris.png|thumb|200px|Debris]]
Creates a debris particle effect (e.g. bits that fly off a car when ramming a wall).

==Syntax==
<syntaxhighlight lang="lua">
bool fxAddDebris ( float posX, float posY, float posZ, [int colorR=255, int colorG=0, int colorB=0, int colorA=255, float scale=1.0, int count=1] )
</syntaxhighlight>

===Required Arguments===
*'''posX, posY, posZ:''' the world coordinates where the debris originates.

===Optional Arguments===
{{OptionalArg}}
*'''colorR, colorG, colorB, colorA:''' the color and alpha (transparency) of the debris effect.
*'''scale:''' the size of the chunks.
*'''count:''' the number of chunks to create.

===Returns===
Returns a true if the operation was successful, false otherwise.

==Example==
<section name="Client" class="client" show="true">
This example will create a Debris Effect next to you when typing ''/debris'' in the Chatbox.

<syntaxhighlight lang="lua">
addCommandHandler("debris", function()
local x, y, z = getElementPosition(localPlayer)
local randomColor, randomAmount = math.random(0, 255), math.random(4, 8)
fxAddDebris(x, y, z, randomColor, randomColor, randomColor, 255, 1.0, randomAmount)
end)
</syntaxhighlight>
</section>

==See Also==
{{Client Effects functions}}

FxAddDebris

2012-05-25T12:11:08Z

Mehmet Soedir: /* Example */

FxAddBulletImpact

2012-05-25T11:40:47Z

Mehmet Soedir: /* Example */

__NOTOC__
{{Client function}}
[[Image:Fxbulletimpact.png|thumb|200px|Bullet impact]]
Creates a bullet impact particle effect, consisting of a small smoke cloud and a number of sparks.

==Syntax==
<syntaxhighlight lang="lua">
bool fxAddBulletImpact ( float posX, float posY, float posZ, float dirX, float dirY, float dirZ, [int smokeSize=1, int sparkCount=1, float smokeIntensity=1.0] )
</syntaxhighlight>

===Required Arguments===
*'''posX, posY, posZ:''' the world coordinates where the effect originates.
*'''dirX, dirY, dirZ:''' a vector indicating the direction of the effect.

===Optional Arguments===
{{OptionalArg}}
*'''smokeSize:''' the size of the smoke cloud.
*'''sparkCount:''' the number of sparks to create.
*'''smokeIntensity:''' the amount/transparency of smoke, ranges from 0 to 1.

===Example==
<section name="Client" class="client" show="true">
This example will create a Bullet Impact Effect on the position of the bullet impact.

<syntaxhighlight lang="lua">
addEventHandler("onClientPlayerWeaponFire", root, function(weapon, ammo, ammoInClip, hitX, hitY, hitZ, hitElement)
if weapon == 0 then return end -- If the player is unarmed, return end.
fxAddBulletImpact(hitX, hitY, hitZ, 0, 0, 0, math.random(1, 2), math.random(2, 5), 1.0)
end)
</syntaxhighlight>
</section>

==See Also==
{{Client Effects functions}}

FxAddBulletSplash

2012-05-25T11:30:33Z

Mehmet Soedir: Removed from 'Needs Example' list

__NOTOC__
{{Client function}}
[[Image:Fxbulletsplash.png|thumb|200px|Bullet splash]]
This function creates a bullet splash particle effect, normally created when shooting into water.

==Syntax==
<syntaxhighlight lang="lua">
bool fxAddBulletSplash ( float posX, float posY, float posZ )
</syntaxhighlight>

===Required Arguments===
* '''posX:''' A float representing the '''x''' position of the splash
* '''posY:''' A float representing the '''y''' position of the splash
* '''posZ:''' A float representing the '''z''' position of the splash

===Returns===
Returns a true if the operation was successful, false otherwise.

===Example===
<section name="Client" class="client" show="true">
This example will add a Bullet Splash Effect next to your player when typing ''/bsplash'' in the Chatbox.
<syntaxhighlight lang="lua">
addCommandHandler("bsplash", function()
local x, y, z = getElementPosition(localPlayer)
local gz = getGroundPosition(x, y, z)
fxAddBulletSplash(x, y, gz)
end)
</syntaxhighlight>
</section>

==See Also==
{{Client Effects functions}}

FxAddBulletSplash

2012-05-25T11:29:16Z

Mehmet Soedir: /* Example */

InterpolateBetween

2012-05-24T18:31:33Z

Mehmet Soedir: Added third example (Moving camera)

__NOTOC__
{{Server client function}}

Interpolates a 3D Vector between a source value and a target value using either linear interpolation or any other [[Easing|easing function]].
It can also be used to interpolate 2D vectors or scalars by only setting some of the x, y, z values and putting 0 to the others.

==Syntax==
<syntaxhighlight lang="lua">
float float float interpolateBetween ( float x1, float y1, float z1,
float x2, float y2, float z2,
float fProgress, string strEasingType,
[ float fEasingPeriod, float fEasingAmplitude, float fEasingOvershoot ] )
</syntaxhighlight>

===Required Arguments===
*'''x1, y1, z1:''' 3D coordinates of source vector/value
*'''x2, y2, z2:''' 3D coordinates of target vector/value
*'''fProgress:''' float between 0 and 1 indicating the interpolation progress (0 at the beginning of the interpolation, 1 at the end).
*'''strEasingType:''' the [[Easing|easing function]] to use for the interpolation

===Optional Arguments===
*'''fEasingPeriod:''' the period of the [[Easing|easing function]] (only some easing functions use this parameter)
*'''fEasingAmplitude:''' the amplitude of the [[Easing|easing function]] (only some easing functions use this parameter)
*'''fEasingOvershoot:''' the overshoot of the [[Easing|easing function]] (only some easing functions use this parameter)

===Returns===
Returns ''x, y, z'' the interpolated 3D vector/value if successful, ''false'' otherwise (error in parameters).
As mentioned before, interpolateBetween can be used on 2D vectors or scalars in which case only some (x, y or just x) of the returned values are to be used (cf. alpha interpolation in marker example or size interpolation in window example).

== Examples ==
The examples below are only clientside examples even though the function can be used on both sides. Indeed it makes more sense to use it with onClientRender/onClientPreRender but the freedom is given to use it in any other context.
<section name="Client" class="client" show="true">
This clientside example uses interpolateBetween to create position and color interpolation(with effect) on a marker.
The command to test it is "/marker".
The position is interpolated with "OutBounce" as strEasingType to make the marker bounce off the ground and "Linear" interpolation for the color.
<syntaxhighlight lang="lua">
local g_Marker = nil
addCommandHandler("marker",
function ()
if g_Marker then return end

local x, y, z = getElementPosition(getLocalPlayer())
z = z - 1

g_Marker = {}
g_Marker.startPos = {x, y, z + 5}
g_Marker.startTime = getTickCount()
g_Marker.startColor = {255, 0, 0, 0}
g_Marker.endPos = {x, y, z}
g_Marker.endTime = g_Marker.startTime + 2000
g_Marker.endColor = {0, 0, 255, 255}

local x, y, z = unpack(g_Marker.startPos)
local r, g, b, a = unpack(g_Marker.startColor)
g_Marker.marker = createMarker(x, y, z, "cylinder", 1, 255, r, g, b, a)

addEventHandler("onClientRender", getRootElement(), popMarkerUp)
end)

function popMarkerUp()
local now = getTickCount()
local elapsedTime = now - g_Marker.startTime
local duration = g_Marker.endTime - g_Marker.startTime
local progress = elapsedTime / duration

local x1, y1, z1 = unpack(g_Marker.startPos)
local x2, y2, z2 = unpack(g_Marker.endPos)
local x, y, z = interpolateBetween (
x1, y1, z1,
x2, y2, z2,
progress, "OutBounce")

setElementPosition(g_Marker.marker, x, y, z)

local r1, g1, b1, a1 = unpack(g_Marker.startColor)
local r2, g2, b2, a2 = unpack(g_Marker.endColor)
local r, g, b = interpolateBetween (
r1, g1, b1,
r2, g2, b2,
progress, "Linear")
local a = interpolateBetween (
a1, 0, 0,
a2, 0, 0,
progress, "Linear")

setMarkerColor(g_Marker.marker , r, g, b, a)

if now >= g_Marker.endTime then
removeEventHandler("onClientRender", getRootElement(), popMarkerUp)
setTimer(
function ()
destroyElement(g_Marker.marker)
g_Marker = nil
end, 3000, 1)
end
end
</syntaxhighlight>
</section>

<section name="Client" class="client" show="true">
This clientside example uses interpolateBetween to create size and position interpolation (with effect) on a gui-window.
The command to test it is "/window".
When the window pops up it uses "OutElastic" as the strEasingType to create the bouncing/elastic effect.
When it fades away, it uses "InQuad" to have an accelerating fading.
<syntaxhighlight lang="lua">
local g_Window = nil
addCommandHandler("window",
function ()
if g_Window then return end

g_Window = {}

local screenWidth, screenHeight = guiGetScreenSize()
g_Window.windowWidth, g_Window.windowHeight = 400, 315
local left = screenWidth/2 - g_Window.windowWidth/2
local top = screenHeight/2 - g_Window.windowHeight/2

g_Window.window = guiCreateWindow(left, top, g_Window.windowWidth, g_Window.windowHeight, "Interpolation on GUI", false)

g_Window.closeBtn = guiCreateButton(320, 285, 75, 23, "Close", false, g_Window.window)

guiWindowSetSizable(g_Window.window, false)
guiWindowSetMovable(g_Window.window, false)
guiSetEnabled(g_Window.window, false)
guiSetVisible(g_Window.window, false)

g_Window.startTime = getTickCount()
g_Window.startSize = {0, 0}
g_Window.endSize = {g_Window.windowWidth, g_Window.windowHeight}
g_Window.endTime = g_Window.startTime + 1000
addEventHandler("onClientRender", getRootElement(), popWindowUp)
end)

function on_closeBtn_clicked(button, state, absoluteX, absoluteY)
if (button ~= "left") or (state ~= "up") then
return
end

if not g_Window then return end

showCursor(false)
guiSetEnabled(g_Window.window, false)
guiWindowSetMovable(g_Window.window, false)

local screenWidth, screenHeight = guiGetScreenSize()
local posX, posY = guiGetPosition(g_Window.window, false)

g_Window.startTime = getTickCount()
g_Window.startSize = {g_Window.windowWidth, g_Window.windowHeight}
g_Window.startCenter =
{
posX + g_Window.windowWidth/2,
posY + g_Window.windowHeight/2,
}

g_Window.endSize = {0, 0}
g_Window.endTime = g_Window.startTime + 1000
g_Window.endCenter =
{
screenWidth,
screenHeight
}

addEventHandler("onClientRender", getRootElement(), popWindowDown)
end

function popWindowUp()
local now = getTickCount()
local elapsedTime = now - g_Window.startTime
local duration = g_Window.endTime - g_Window.startTime
local progress = elapsedTime / duration

local width, height, _ = interpolateBetween (
g_Window.startSize[1], g_Window.startSize[2], 0,
g_Window.endSize[1], g_Window.endSize[2], 0,
progress, "OutElastic")

guiSetSize(g_Window.window, width, height, false)

local screenWidth, screenHeight = guiGetScreenSize()
guiSetPosition(g_Window.window, screenWidth/2 - width/2, screenHeight/2 - height/2, false)

if not guiGetVisible(g_Window.window) then
guiSetVisible(g_Window.window, true)
guiBringToFront(g_Window.window)
end

if now >= g_Window.endTime then
guiSetEnabled(g_Window.window, true)

guiBringToFront(g_Window.window)
removeEventHandler("onClientRender", getRootElement(), popWindowUp)
addEventHandler("onClientGUIClick", g_Window.closeBtn, on_closeBtn_clicked, false)
showCursor(true)
guiWindowSetMovable(g_Window.window, true)
end
end

function popWindowDown()
local now = getTickCount()
local elapsedTime = now - g_Window.startTime
local duration = g_Window.endTime - g_Window.startTime
local progress = elapsedTime / duration

local width, height, _ = interpolateBetween (
g_Window.startSize[1], g_Window.startSize[2], 0,
g_Window.endSize[1], g_Window.endSize[2], 0,
progress, "InQuad")

guiSetSize(g_Window.window, width, height, false)

local centerX, centerY, _ = interpolateBetween (
g_Window.startCenter[1], g_Window.startCenter[2], 0,
g_Window.endCenter[1], g_Window.endCenter[2], 0,
progress, "InQuad")

guiSetPosition(g_Window.window, centerX - width/2, centerY - height/2, false)

if now >= g_Window.endTime then
removeEventHandler("onClientRender", getRootElement(), popWindowDown)
destroyElement(g_Window.window)
g_Window = nil
end
end

</syntaxhighlight>
</section>

<section name="Client" class="client" show="true">
This clientside example uses interpolateBetween to create and position interpolation (with effect) on a camera.
The command to test it is "/ccam".
When the camera pops up it uses "OutQuad" as the strEasingType to create the slow down effect.
<syntaxhighlight lang="lua">
local enabled = false

addCommandHandler("ccam", function()
enabled = not enabled
if enabled then
start = getTickCount()
dx, dy, dz, lx, ly, lz = getCameraMatrix()
addEventHandler("onClientPreRender", root, interpolateCam)
else
start = nil
setCameraTarget(localPlayer)
removeEventHandler("onClientPreRender", root, interpolateCam)
end
end)

function interpolateCam()
local now = getTickCount()
local endTime = start + 2000
local elapsedTime = now - start
local duration = endTime - start
local progress = elapsedTime / duration
local px, py, pz = getElementPosition(localPlayer)
local x, y, z = interpolateBetween ( dx, dy, dz, dx+4, dy+4, dz, progress, "OutQuad")
setCameraMatrix(x, y, z, px, py, pz+0.6, 0, 0)
end
</syntaxhighlight>
</section>

==See Also==
{{Utility functions}}

GetVehicleTurnVelocity

2012-05-24T18:14:04Z

Mehmet Soedir: Removed from 'Needs Example' list

{{Server client function}}
__NOTOC__
This function is used to retrieve a vehicle's turning velocity for each axis.

==Syntax==
<syntaxhighlight lang="lua">
float float float getVehicleTurnVelocity ( vehicle theVehicle )
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The [[vehicle]] you wish to get the turning velocities of.

===Returns===
Returns 3 ''floats'' that represent the vehicle's turning velocity on the x, y and z axis or ''false'' if wrong arguments were passed.

===Example===
<section name="Server" class="server" show="true">
This example shows the current turn velocity of the vehicle that you're in.

<syntaxhighlight lang="lua">
addCommandHandler("geturnvelocity", function(player)
if not isPedInVehicle(player) then return end
local veh = getPedOccupiedVehicle(player)
local vx, vy, vz = getVehicleTurnVelocity(veh)
outputChatBox("Vehicle's turn velocity is: X: "..vx.." Y: "..vy.." Z: "..vz, player, 0, 255, 0, false)
end)
</syntaxhighlight>
</section>

==See Also==

{{Vehicle functions}}

XmlDestroyNode

2012-05-24T18:13:02Z

Mehmet Soedir: Removed from 'Needs Example' list

__NOTOC__
{{Server client function}}
This function destroys a XML node from the XML node tree.

==Syntax==
<syntaxhighlight lang="lua">
bool xmlDestroyNode ( xmlnode theXMLNode )
</syntaxhighlight>

===Required Arguments===
*'''theXMLNode:''' The [[xml node]] you want to destroy.

===Returns===
Returns ''true'' if the [[xml node]] was successfully destroyed, ''false'' otherwise.

===Example===
<section name="Server" class="server" show="true">
This example will add a command called '/delnode' and it will create an xml file called 'test.xml'.

<syntaxhighlight lang="lua">
addEventHandler("onResourceStart", resourceRoot, function()
xml = xmlLoadFile("test.xml")
if not xml then
xml = xmlCreateFile("test.xml", "root")
xmlCreateChild(xml, "node")
xmlSaveFile(xml)
end
end)

addCommandHandler("delnode", function(player)
local node = xmlFindChild(xml, "node", 0)
if not node then xmlUnloadFile(xml) return end
xmlDestroyNode(node)
xmlSaveFile(xml)
xmlUnloadFile(xml)
outputChatBox("You destroyed the node!", player, 0, 255, 0, false)
end)
</syntaxhighlight>
</section>

==See Also==
{{XML functions}}

XmlDestroyNode

2012-05-24T18:06:36Z

Mehmet Soedir: /* Example */

User:Mehmet Soedir

2012-05-24T17:49:15Z

Mehmet Soedir: Profile Page

[[Image:Coder.gif]] '''This user is a furious scripter'''

OnClientSoundChangedMeta

2012-05-24T16:34:04Z

Mehmet Soedir: /* See Also */

__NOTOC__
{{Client event}}
This event is triggered when a sound's meta tags have been modified.

==Parameters==
<syntaxhighlight lang="lua">
string streamTitle
</syntaxhighlight>

*'''streamTitle''': The title of a specific stream

==Source==
The [[event system#Event source|source]] of this event is the [[sound]] of which the meta tags have just been modified.

==Example==
<section name="Client" class="client" show="true">
This example will output the new stream title in the chatbox.

<syntaxhighlight lang="lua">
addEventHandler("onClientSoundChangedMeta", root, function(streamTitle)
outputChatBox("* Now streaming: "..streamTitle, 255, 200, 0, false)
end)
</syntaxhighlight>
</section>

==See Also==

{{Sound events}}

OnClientSoundChangedMeta

2012-05-24T16:32:49Z

Mehmet Soedir: /* See Also */

OnClientSoundChangedMeta

2012-05-24T16:32:09Z

Mehmet Soedir: Added See Also menu (Deleted by accident)

OnClientSoundChangedMeta

2012-05-24T16:30:38Z

Mehmet Soedir: Fixed error

OnClientSoundChangedMeta

2012-05-24T16:29:51Z

Mehmet Soedir: /* Example */

GetProjectileCreator

2012-05-24T16:20:39Z

Mehmet Soedir: Cleaned up example

__NOTOC__
{{Client function}}
This function returns the creator of the specified projectile.

==Syntax==
<syntaxhighlight lang="lua">
element getProjectileCreator ( projectile theProjectile )
</syntaxhighlight>

==Required Arguments==
*'''theProjectile:''' The [[projectiles| projectile]] element which creator you want to retrieve.

==Returns==
Returns the element which created the projectile if successful, ''false'' otherwise.

==Example==

<section name="Client" class="client" show="true">
This example will output a message in the chatbox saying who created
the projectile.
<syntaxhighlight lang="lua">
addEventHandler("onClientProjectileCreation", root, function(projectile)
local creator = getProjectileCreator(projectile)
if (getElementType(creator) == "player") then
local pName = getPlayerName(creator)
local projectileID = getProjectileType(projectile)
outputChatBox(pName.." created a projectile! (ID: "..projectileID..")", 255, 200, 0, false)
end
end)
</syntaxhighlight>
</section>

==See also==
{{Client projectile functions}}

[[it:getProjectileCreator]]

GetVehicleTurnVelocity

2012-05-24T16:18:48Z

Mehmet Soedir: /* Example */

GetProjectileCreator

2012-05-24T16:10:40Z

Mehmet Soedir: Removed from 'Needs Example' list

__NOTOC__
{{Client function}}
This function returns the creator of the specified projectile.

==Syntax==
<syntaxhighlight lang="lua">
element getProjectileCreator ( projectile theProjectile )
</syntaxhighlight>

==Required Arguments==
*'''theProjectile:''' The [[projectiles| projectile]] element which creator you want to retrieve.

==Returns==
Returns the element which created the projectile if successful, ''false'' otherwise.

==Example==
This example will output a message in the chatbox saying who created
The projectile.

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
addEventHandler("onClientProjectileCreation", root, function(projectile)
local creator = getProjectileCreator(projectile)
if (getElementType(creator) == "player") then
local pName = getPlayerName(creator)
local projectileID = getProjectileType(projectile)
outputChatBox(pName.." created a projectile! (ID: "..projectileID..")", 255, 200, 0, false)
end
end)
</syntaxhighlight>
</section>

==See also==
{{Client projectile functions}}

[[it:getProjectileCreator]]

GetProjectileCreator

2012-05-24T16:08:08Z

Mehmet Soedir: Added example description

__NOTOC__
{{Client function}}
{{Needs Example}}
This function returns the creator of the specified projectile.

==Syntax==
<syntaxhighlight lang="lua">
element getProjectileCreator ( projectile theProjectile )
</syntaxhighlight>

==Required Arguments==
*'''theProjectile:''' The [[projectiles| projectile]] element which creator you want to retrieve.

==Returns==
Returns the element which created the projectile if successful, ''false'' otherwise.

==Example==
This example will output a message in the chatbox saying who created
The projectile.

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
addEventHandler("onClientProjectileCreation", root, function(projectile)
local creator = getProjectileCreator(projectile)
if (getElementType(creator) == "player") then
local pName = getPlayerName(creator)
local projectileID = getProjectileType(projectile)
outputChatBox(pName.." created a projectile! (ID: "..projectileID..")", 255, 200, 0, false)
end
end)
</syntaxhighlight>
</section>

==See also==
{{Client projectile functions}}

[[it:getProjectileCreator]]

GetProjectileCreator

2012-05-24T16:03:31Z

Mehmet Soedir: /* Example */

__NOTOC__
{{Client function}}
{{Needs Example}}
This function returns the creator of the specified projectile.

==Syntax==
<syntaxhighlight lang="lua">
element getProjectileCreator ( projectile theProjectile )
</syntaxhighlight>

==Required Arguments==
*'''theProjectile:''' The [[projectiles| projectile]] element which creator you want to retrieve.

==Returns==
Returns the element which created the projectile if successful, ''false'' otherwise.

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
addEventHandler("onClientProjectileCreation", root, function(projectile)
local creator = getProjectileCreator(projectile)
if (getElementType(creator) == "player") then
local pName = getPlayerName(creator)
local projectileID = getProjectileType(projectile)
outputChatBox(pName.." created a projectile! (ID: "..projectileID..")", 255, 200, 0, false)
end
end)
</syntaxhighlight>
</section>

==See also==
{{Client projectile functions}}

[[it:getProjectileCreator]]

GetProjectileCreator

2012-05-24T15:59:56Z

Mehmet Soedir: Added example

__NOTOC__
{{Client function}}
{{Needs Example}}
This function returns the creator of the specified projectile.

==Syntax==
<syntaxhighlight lang="lua">
element getProjectileCreator ( projectile theProjectile )
</syntaxhighlight>

==Required Arguments==
*'''theProjectile:''' The [[projectiles| projectile]] element which creator you want to retrieve.

==Returns==
Returns the element which created the projectile if successful, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
addEventHandler("onClientProjectileCreation", root, function(projectile)
local creator = getProjectileCreator(projectile)
if (getElementType(creator) == "player") then
local pName = getPlayerName(creator)
local projectileID = getProjectileType(projectile)
outputChatBox(pName.." created a projectile! (ID: "..projectileID..")", 255, 200, 0, false)
end
end)
</syntaxhighlight>

==See also==
{{Client projectile functions}}

[[it:getProjectileCreator]]