Multi Theft Auto: Wiki - User contributions [en]

Talk:SetSoundEffectEnabled

2010-08-12T21:55:01Z

Madis:

List of effects:
chorus
compressor
distortion
echo
flanger
gargle
i3dl2reverb
parameq
reverb

e.g
setSoundEffectEnabled("distortion", true)

---

Maybe better argument name than 'toggle' would be 'isEnabled', though maybe it comes from the source code.

---<br>
How I hear the effects:<br>
-- weird UFO noise<br>
gargle<br>
-- limits high sounds<br>
compressor<br>
-- large hall or city-like<br>
echo<br>
-- behind the door<br>
i3dl2reverb<br>
-- like too loud for that shitty speaker (e.g. grammofon)<br>
distortion<br>
-- A chorus effect occurs when individual sounds with roughly the same timbre and nearly (but never exactly) the same pitch converge and are perceived as one. While similar sounds coming from multiple sources can occur naturally (as in the case of a choir or string orchestra), it can also be simulated using an electronic effects unit or signal processing device.<br>
chorus<br>
-- parametrical equalizer? where are the settings then?<br>
parameq<br>
-- live in small next room<br>
reverb<br>
-- trancy effect<br>
flanger<br>

Talk:SetSoundEffectEnabled

2010-08-12T20:23:18Z

Madis:

Talk:SetSoundEffectEnabled

2010-08-09T01:49:53Z

Madis: Created page with 'List of effects: chorus compressor distortion echo flanger gargle i3dl2reverb parameq reverb e.g setSoundEffectEnabled("distortion", true)'

List of effects:
chorus
compressor
distortion
echo
flanger
gargle
i3dl2reverb
parameq
reverb

e.g
setSoundEffectEnabled("distortion", true)

Talk:Editor/EDF

2010-04-13T02:35:48Z

Madis: Created page with 'There's currently a bug where rotation isn't added from edf: http://bugs.mtasa.com/view.php?id=5175 - Madis (13/04/10)'

There's currently a bug where rotation isn't added from edf: http://bugs.mtasa.com/view.php?id=5175
- Madis (13/04/10)

Talk:IsPlayerDead

2010-01-31T05:30:06Z

Madis: Created page with 'Should this be Client Only, as it's not in the http://wiki.multitheftauto.com/wiki/Client_Scripting_Functions and there's isPedDead for server-side'

Should this be Client Only, as it's not in the http://wiki.multitheftauto.com/wiki/Client_Scripting_Functions and there's isPedDead for server-side

GetDistanceBetweenPointAndSegment2D

2010-01-24T20:14:33Z

Madis:

{{Useful Function}}
<lowercasetitle></lowercasetitle>
__NOTOC__
Takes point coordinates and line (a segment) starting and ending coordinates. It returns the shortest distance between the point and the line.

==Syntax==
<syntaxhighlight lang="lua">float getDistanceBetweenPointAndSegment2D(float pointX, float pointY, float x1, float y1, float x2, float y2)</syntaxhighlight>

===Required Arguments===
* '''pointX''': The X coordinate of the point.
* '''pointY''': The Y coordinate of the point.
* '''x1''': The X coordinate of the starting point of the line.
* '''y1''': The Y coordinate of the starting point of the line.
* '''x2''': The X coordinate of the ending point of the line.
* '''y2''': The Y coordinate of the ending point of the line.

==Code==
<section name="Function source" class="both" show="true">
<syntaxhighlight lang="lua">
function getDistanceBetweenPointAndSegment2D(pointX, pointY, x1, y1, x2, y2)
local A = pointX - x1
local B = pointY - y1
local C = x2 - x1
local D = y2 - y1

local point = A * C + B * D
local lenSquare = C * C + D * D
local parameter = point / lenSquare

local shortestX
local shortestY

if parameter < 0 then
shortestX = x1
shortestY = y1
elseif parameter > 1 then
shortestX = x2
shortestY = y2
else
shortestX = x1 + parameter * C
shortestY = y1 + parameter * D
end

local distance = getDistanceBetweenPoints2D(pointX, pointY, shortestX, shortestY)

return distance
end
</syntaxhighlight>
</section>

==Example==
<section name="Client" class="client" show="true">
This code draws a red line, enables mouse cursor and tells client how far from the line was clicked.
<syntaxhighlight lang="lua">
-- Draw a red line
addEventHandler("onClientRender", getRootElement(),
function()
dxDrawLine(20, 20, 200, 100, tocolor(255, 0, 0))
end
)

-- Show cursor
showCursor(true)

-- Fires when left mouse button is clicked
function cursorPositionFromTheRedLine(button, state, clickedX, clickedY)
-- Allow function to continue only if left button was pressed and button was pressed down
if button ~= "left" or state == "up" then
return
end

-- Calculate the distance
local distance = getDistanceBetweenPointAndSegment2D(clickedX, clickedY, 20, 20, 200, 100)

-- Tell user the distance
outputChatBox("You clicked "..distance.." away from the Red Line!")
end

-- Read mouse clicks
addEventHandler("onClientClick", root, cursorPositionFromTheRedLine)
</syntaxhighlight>
</section>

Code from: http://www.allegro.cc/forums/thread/589720

==See Also==
{{Useful_Functions}}

Talk:Hibakeresés

2010-01-24T18:18:33Z

Madis: Created page with 'Isn't isTimer already MTA function? http://wiki.mtasa.com/wiki/IsTimer Also, is this really the way MTA isTimer works? If having a lot of timers, better method would be to remove…'

Isn't isTimer already MTA function?
http://wiki.mtasa.com/wiki/IsTimer
Also, is this really the way MTA isTimer works? If having a lot of timers, better method would be to remove the table key in the function setTimer references to. And onColShapeLeave just check if the key exists.
--Madis

GetDistanceBetweenPointAndSegment2D

2010-01-24T03:21:46Z

Madis:

{{Useful Function}}
<lowercasetitle></lowercasetitle>
__NOTOC__
Takes point coordinates and line (a segment) starting and ending coordinates. It returns the shortest distance between the point and the line.

==Syntax==
<syntaxhighlight lang="lua">float getDistanceBetweenPointAndSegment2D(float pointX, float pointY, float x1, float y1, float x2, float y2)</syntaxhighlight>

===Required Arguments===
* '''pointX''': The X coordinate of the point.
* '''pointY''': The Y coordinate of the point.
* '''x1''': The X coordinate of the starting point of the line.
* '''y1''': The Y coordinate of the starting point of the line.
* '''x2''': The X coordinate of the ending point of the line.
* '''y2''': The Y coordinate of the ending point of the line.

==Code==
<section name="Function source" class="both" show="true">
<syntaxhighlight lang="lua">
function getDistanceBetweenPointAndSegment2D(pointX, pointY, x1, y1, x2, y2)
local A = pointX - x1
local B = pointY - y1
local C = x2 - x1
local D = y2 - y1

local point = A * C + B * D
local lenSquare = C * C + D * D
local parameter = point / lenSquare

local shortestX
local shortestY

if parameter < 0 then
shortestX = x1
shortestY = y1
elseif parameter > 1 then
shortestX = x2
shortestY = y2
else
shortestX = x1 + parameter * C
shortestY = y1 + parameter * D
end

local distance = getDistanceBetweenPoints2D(pointX, pointY, shortestX, shortestY)

return distance
end
</syntaxhighlight>
</section>

==Example==
<section name="Server" class="client" show="true">
This code draws a red line, enables mouse cursor and tells client how far from the line was clicked.
<syntaxhighlight lang="lua">
-- Draw a red line
addEventHandler("onClientRender", getRootElement(),
function()
dxDrawLine(20, 20, 200, 100, tocolor(255, 0, 0)
end
)

-- Show cursor
showCursor(true)

-- Fires when left mouse button is clicked
function cursorPositionFromTheRedLine(button, state, clickedX, clickedY)
-- Allow function to continue only if left button was pressed and button was pressed down
if button ~= "left" or state == "up" then
return
end

-- Calculate the distance
local distance = getDistanceBetweenPointAndSegment2D(clickedX, clickedY, 20, 20, 200, 100)

-- Tell user the distance
outputChatBox("You clicked "..distance.." away from the Red Line!")
end

-- Read mouse clicks
addEventHandler("onClientClick", root, cursorPositionFromTheRedLine)
</syntaxhighlight>
</section>

Code from: http://www.allegro.cc/forums/thread/589720

==See Also==
{{Useful_Functions}}

Talk:IsYearALeapYear

2010-01-24T03:17:56Z

Madis:

How is this an useful function? --Madis
Oh, for http://wiki.mtasa.com/wiki/GetTimestamp -- Madis

GetDistanceBetweenPointAndSegment2D

2010-01-24T03:15:41Z

Madis: Created page with '{{Useful Function}} <lowercasetitle></lowercasetitle> __NOTOC__ Takes point coordinates and line (a segment) starting and ending coordinates. It returns the shortest distance bet…'

{{Useful Function}}
<lowercasetitle></lowercasetitle>
__NOTOC__
Takes point coordinates and line (a segment) starting and ending coordinates. It returns the shortest distance between the point and the line.

==Syntax==
<syntaxhighlight lang="lua">float getDistanceBetweenPointAndSegment2D(float pointX, float pointY, float x1, float y1, float x2, float y2)</syntaxhighlight>

===Required Arguments===
* '''pointX''': The X coordinate of the point.
* '''pointY''': The Y coordinate of the point.
* '''x1''': The X coordinate of the starting point of the line.
* '''y1''': The Y coordinate of the starting point of the line.
* '''x2''': The X coordinate of the ending point of the line.
* '''y2''': The Y coordinate of the ending point of the line.

==Code==
<section name="Function source" class="both" show="true">
<syntaxhighlight lang="lua">
function getDistanceBetweenPointAndSegment2D(pointX, pointY, x1, y1, x2, y2)
local A = pointX - x1
local B = pointY - y1
local C = x2 - x1
local D = y2 - y1

local point = A * C + B * D
local lenSquare = C * C + D * D
local parameter = point / lenSquare

local shortestX
local shortestY

if parameter < 0 then
shortestX = x1
shortestY = y1
elseif parameter > 1 then
shortestX = x2
shortestY = y2
else
shortestX = x1 + parameter * C
shortestY = y1 + parameter * D
end

local distance = getDistanceBetweenPoints2D(pointX, pointY, shortestX, shortestY)

return distance
end
</syntaxhighlight>
</section>

==Example==
<section name="Server" class="client" show="true">
This code draws a red line, enables mouse cursor and tells client how far from the line was clicked.
<syntaxhighlight lang="lua">
-- Draw a red line
addEventHandler("onClientRender", getRootElement(),
function()
dxDrawLine(20, 20, 200, 100, tocolor(255, 0, 0)
end
)

-- Show cursor
showCursor(true)

-- Fires when left mouse button is clicked
function cursorPositionFromTheRedLine(button, state, clickedX, clickedY)
-- Allow function to continue only if left button was pressed and button was pressed down
if button ~= "left" or state == "up" then
return
end

-- Calculate the distance
local distance = distanceBetweenPointAndSegment(clickedX, clickedY, 20, 20, 200, 100)

-- Tell user the distance
outputChatBox("You clicked "..distance.." away from the Red Line!")
end

-- Read mouse clicks
addEventHandler("onClientClick", root, cursorPositionFromTheRedLine)
</syntaxhighlight>
</section>

Code from: http://www.allegro.cc/forums/thread/589720

==See Also==
{{Useful_Functions}}

Talk:DxDrawImage

2010-01-24T01:10:13Z

Madis:

I added note to filepath that .dds images are also supported, though it's not the best solution, a proper list would be better. --Madis

Current image types I know that work:
dds
png

Image types that seem not to work:
jpg

--Madis

Talk:DxDrawImage

2009-11-23T23:56:02Z

Madis:

I added note to filepath that .dds images are also supported, though it's not the best solution, a proper list would be better. --Madis

Talk:DxDrawImage

2009-11-23T23:55:53Z

Madis: Created page with 'I added note to filepath that .dds images are also supported, though it's not the best solution, a proper list would be better.'

I added note to filepath that .dds images are also supported, though it's not the best solution, a proper list would be better.

DxDrawImage

2009-11-23T23:55:00Z

Madis: /* Required Arguments */

__NOTOC__
{{Client function}}

Draws an image on the screen for a single frame. In order for the image to stay visible continuously, you need to call this function with the same parameters on each frame update (see [[onClientRender]]).

==Syntax==
<syntaxhighlight lang="lua">
bool dxDrawImage ( float posX, float posY, float width, float height, string filepath [, float rotation = 0, float rotationCenterOffsetX = 0, float rotationCenterOffsetY = 0, int color = white, bool postGUI = false ] )
</syntaxhighlight>

===Required Arguments===
*'''posX:''' the absolute X coordinate of the top left corner of the image
*'''posY:''' the absolute Y coordinate of the top left corner of the image
*'''width:''' the absolute width of the image (must be a power of two or image might be blurry)
*'''height:''' the absolute height of the image (must be a power of two or image might be blurry)
*'''filepath:''' The [[filepath]] of the image which is going to be drawn. (.dds images are also supported)

===Optional Arguments===
*'''rotation:''' the rotation, in degrees for the image.
*'''rotationCenterOffsetX:''' the absolute X offset from the image center for which to rotate the image from.
*'''rotationCenterOffsetY:''' the absolute Y offset from the image center for which to rotate the image from.
*'''color:''' the color of the image, a value produced by [[tocolor]] or hexadecimal number in format: 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).
*'''postgui :''' A bool representing whether the image should be drawn on top of or behind any ingame GUI (rendered by CEGUI).

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

==Example==
<section name="Client" class="client" show="true">
Example of a pendulum swinging from the top of the screen, made using dxDrawImage.
<syntaxhighlight lang="lua">
local rootElement = getRootElement()
local screenWidth,screenHeight = guiGetScreenSize() -- Get screen resolution.

function renderDisplay ( )
local seconds = getTickCount() / 1000
local angle = math.sin(seconds) * 80
-- This will draw the graphic file 'arrow.png' at the top middle of the screen
-- using the size of 100 pixels wide, and 240 pixels high.
-- The center of rotation is at the top of the image.
dxDrawImage ( screenWidth/2 - 50, 0, 100, 240, 'arrow.png', angle, 0, -120 )
end

function HandleTheRendering ( )
addEventHandler("onClientRender",rootElement, renderDisplay) -- Keep everything visible with onClientRender.
end
addEventHandler("onClientResourceStart",rootElement, HandleTheRendering)
</syntaxhighlight>
</section>

==See Also==
{{Drawing_functions}}

OnVehicleExplode

2009-11-22T08:41:16Z

Madis: /* Example 2 */

__NOTOC__
{{Server event}}
This event is triggered when a vehicle explodes.

==Parameters==
No arguments

==Source==
The [[event system#Event source|source]] of this event is the [[vehicle]] that exploded.

==Example==
<syntaxhighlight lang="lua">
vagosVehicle = nil

-- This will get called when the vagos vehicle explodes
function onVagosVehicleExplode ()
outputChatBox ( "VAGOS VEHICLE DESTROYED!" )
end

-- This is called when THIS resource starts
function onThisResourceStart ()

-- Create the vagos vehicle. A van.
vagosVehicle = createVehicle ( 522, 0, 0, 5 )

-- Add its explode handler. When this car explodes, onVagosVehicleExplode is called
addEventHandler ( "onVehicleExplode", vagosVehicle, onVagosVehicleExplode )
end

--Add the resource start event
addEventHandler ( "onResourceStart", getResourceRootElement ( getThisResource () ), onThisResourceStart )
</syntaxhighlight>

==Example 2==

This will show name of any vehicle that blew up
<syntaxhighlight lang="lua">

function notifyAboutExplosion()
-- source is the element that triggered the event and can be used in other events as well
outputChatBox(getVehicleName(source).." just blew up")
end

-- by using getRootElement() as root, it works for any vehicle
addEventHandler("onVehicleExplode", getRootElement(), notifyAboutExplosion)
</syntaxhighlight>

{{See also/Server event|Vehicle events}}

OnVehicleExplode

2009-11-22T08:40:02Z

Madis: /* Example */

__NOTOC__
{{Server event}}
This event is triggered when a vehicle explodes.

==Parameters==
No arguments

==Source==
The [[event system#Event source|source]] of this event is the [[vehicle]] that exploded.

==Example==
<syntaxhighlight lang="lua">
vagosVehicle = nil

-- This will get called when the vagos vehicle explodes
function onVagosVehicleExplode ()
outputChatBox ( "VAGOS VEHICLE DESTROYED!" )
end

-- This is called when THIS resource starts
function onThisResourceStart ()

-- Create the vagos vehicle. A van.
vagosVehicle = createVehicle ( 522, 0, 0, 5 )

-- Add its explode handler. When this car explodes, onVagosVehicleExplode is called
addEventHandler ( "onVehicleExplode", vagosVehicle, onVagosVehicleExplode )
end

--Add the resource start event
addEventHandler ( "onResourceStart", getResourceRootElement ( getThisResource () ), onThisResourceStart )
</syntaxhighlight>

==Example 2==

This will show name of any vehicle that blew up
<syntaxhighlight lang="lua">

function notifyAboutExplosion()
-- source is the element that triggered the event and can be used in other events as well
outputChatBox(getVehicleName(source))
end

-- by using getRootElement() as root, it works for any vehicle
addEventHandler("onVehicleExplode", getRootElement(), notifyAboutExplosion)
</syntaxhighlight>

{{See also/Server event|Vehicle events}}

Talk:IsYearALeapYear

2009-11-21T04:03:21Z

Madis:

How is this an useful function? --Madis

Talk:IsYearALeapYear

2009-11-21T04:02:53Z

Madis: Created page with 'How is this an useful function?'

How is this an useful function?

OnClientVehicleStartExit

2009-11-19T05:18:00Z

Madis:

[[Category:Incomplete Event]]
{{Client event}}
__NOTOC__
This event is triggered when a player starts exiting a vehicle. Once the exiting animation completes, [[onClientVehicleExit]] is triggered.

==Parameters==
<syntaxhighlight lang="lua">
player thePlayer, int seat
</syntaxhighlight>
*'''thePlayer:''' the player who started exiting the vehicle.
*'''seat:''' the number of the seat that the player was sitting on.

==Source==
The source of this event is the vehicle that the player started to exit.

==Example==

<syntaxhighlight lang="lua">

</syntaxhighlight>

==See Also==
===Client vehicle events===
{{Client_vehicle_events}}
===Client event functions===
{{Client_event_functions}}

OnClientElementDataChange

2009-11-19T02:00:05Z

Madis: /* Parameters */

{{Client event}}
__NOTOC__
This event is triggered whenever an element's ''[[element data]]'' is changed.

==Parameters==
<syntaxhighlight lang="lua">
string dataName, string oldValue
</syntaxhighlight>

*'''dataName''': A string representing the element data that was changed
*'''oldValue''': A string representing the value before changed element data

==Source==
The [[event system#Event source|source]] of this event is the [[element]] that had its element data changed

==Example==
This example tells the client whenever a player's "score" element data is changed.
<syntaxhighlight lang="lua">
addEventHandler ( "onClientElementDataChange", getRootElement(),
function ( dataName )
if getElementType ( source ) == "player" and dataName == "score" then
outputChatBox ( getPlayerName(source).."'s new score is "..getElementData (source, "score").."!" )
end
end )
</syntaxhighlight>

==See Also==
===Client element events===
{{Client_element_events}}
===Client event functions===
{{Client_event_functions}}