Multi Theft Auto: Wiki - User contributions [en]

Client Scripting Functions

2021-12-08T14:28:02Z

Fixelly: Changed redirect target from Https://www.youtube.com/watch?v=dQw4w9WgXcQ to New website

#REDIRECT [[New website]]

Client Scripting Functions

2021-12-08T14:27:50Z

Fixelly: Redirected page to Https://www.youtube.com/watch?v=dQw4w9WgXcQ

#REDIRECT [[https://www.youtube.com/watch?v=dQw4w9WgXcQ]]

Useful Functions

2021-12-08T14:24:55Z

Fixelly:

<pageclass class="#228B22"></pageclass>
{{MessageBox|
bordercolorhex = 000000 |
bordertype = dotted |
bgcolorhex = EFEFEF |
image = File:Package-x-generic.png |
title = Don't forget to check out the [[Useful Classes]] |
subtext = <span style="font-size: 85%;">''That page lists user-made classes that are not included by default in MTA. ''</span> |
}}
{{Adding_Pages_to_Categories_and_Templates}}

This page lists user-made Lua functions that are not included by default in MTA. Its purpose is to quickly provide some useful functions for scripters, so they do not waste time recreating them when needed.
__TOC__

{{Useful_Functions}}

[[HU:Useful Functions]]
[[ES:Funciones Útiles]]
[[ru:Полезные функции]]
[[de:Nützliche_Funktionen]]
[[PL:Użyteczne Funkcje]]
[[Ar:وظائف مفيدة]]

Useful Functions

2021-12-08T14:23:12Z

Fixelly: Replaced content with "guwniarz"

guwniarz

DxDrawBluredRectangle

2021-07-05T07:02:06Z

Fixelly:

{{Useful Function}}
<lowercasetitle/>
__NOTOC__
This function draws a 2D blured rectangle on the screen - rendered for one frame. This should be used in conjunction with onClientRender for continuous display.

== Syntax ==
<syntaxhighlight lang="lua">
bool dxDrawBluredRectangle ( float x, float y, float width, float height )
</syntaxhighlight>

=== Required Arguments ===
* '''x:''' An float representing the '''absolute''' origin X position of the rectangle, represented by pixels on the screen.
* '''y:''' An float representing the '''absolute''' origin Y position of the rectangle, represented by pixels on the screen.
* '''width:''' An float representing the width of the rectangle, drawn in a ''right'' direction from the origin.
* '''height:''' An float representing the height of the rectangle, drawn in a ''downwards'' direction from the origin.

=== Required Files ===
[https://cdn.discordapp.com/attachments/851000636484747274/861170045651910686/mta-helper.fx mta-helper.fx],
[https://cdn.discordapp.com/attachments/851000636484747274/861170037255307294/blurV.fx blurV.fx],
[https://cdn.discordapp.com/attachments/851000636484747274/861170034495455232/blurH.fx blurH.fx]

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

== Code ==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
local scx, scy = guiGetScreenSize()

Settings = {}
Settings.var = {}
Settings.var.blur = 1
Settings.var.optim = 4
Settings.screenRectangle = {}

local current

function createShader()
myScreenSource = dxCreateScreenSource( scx/Settings.var.optim, scy/Settings.var.optim )
blurHShader,tecName = dxCreateShader( "shaders/blurH.fx" )
blurVShader,tecName = dxCreateShader( "shaders/blurV.fx" )
bAllValid = myScreenSource and blurHShader and blurVShader
end
createShader()

function preRender ()
if not Settings.var then
return
end
RTPool.frameStart()
dxUpdateScreenSource( myScreenSource )
current = myScreenSource
current = applyGBlurH( current, Settings.var.blur )
current = applyGBlurV( current, Settings.var.blur )
dxSetRenderTarget()
end
addEventHandler ("onClientRender", root, preRender)

function dxDrawBluredRectangle (pos_x, pos_y, size_x, size_y, color)
if bAllValid then
dxDrawImageSection ( pos_x, pos_y, size_x, size_y, pos_x/Settings.var.optim, pos_y/Settings.var.optim, size_x/Settings.var.optim, size_y/Settings.var.optim, current, 0,0,0, color)
end
end

function applyGBlurH( Src, blur )
if not Src then return nil end
local mx,my = dxGetMaterialSize( Src )
local newRT = RTPool.GetUnused(mx,my)
if not newRT then return nil end
dxSetRenderTarget( newRT, true )
dxSetShaderValue( blurHShader, "TEX0", Src )
dxSetShaderValue( blurHShader, "TEX0SIZE", mx,my )
dxSetShaderValue( blurHShader, "BLUR", blur )
dxDrawImage( 0, 0, mx, my, blurHShader )
return newRT
end

function applyGBlurV( Src, blur )
if not Src then return nil end
local mx,my = dxGetMaterialSize( Src )
local newRT = RTPool.GetUnused(mx,my)
if not newRT then return nil end
dxSetRenderTarget( newRT, true )
dxSetShaderValue( blurVShader, "TEX0", Src )
dxSetShaderValue( blurVShader, "TEX0SIZE", mx,my )
dxSetShaderValue( blurVShader, "BLUR", blur )
dxDrawImage( 0, 0, mx,my, blurVShader )
return newRT
end

RTPool = {}
RTPool.list = {}

function RTPool.frameStart()
for rt,info in pairs(RTPool.list) do
info.bInUse = false
end
end

function RTPool.GetUnused( mx, my )
for rt,info in pairs(RTPool.list) do
if not info.bInUse and info.mx == mx and info.my == my then
info.bInUse = true
return rt
end
end

local rt = dxCreateRenderTarget( mx, my )
if rt then
RTPool.list[rt] = { bInUse = true, mx = mx, my = my }
end
return rt
end</syntaxhighlight>
</section>

== Example ==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
local scx, scy = guiGetScreenSize()

function drawBluredRectangle()
dxDrawBluredRectangle( scx/3.8, scy/3.8, scx/2.02, scy/2 )
end

addEventHandler("onClientRender", root, drawBluredRectangle)</syntaxhighlight>
</section>

===== Author: fiXlly, WaRuS =====

DxDrawBluredRectangle

2021-07-05T06:59:05Z

Fixelly:

{{Useful Function}}
<lowercasetitle/>
__NOTOC__
This function draws a 2D blured rectangle on the screen - rendered for one frame. This should be used in conjunction with onClientRender for continuous display.

== Syntax ==
<syntaxhighlight lang="lua">
bool dxDrawBluredRectangle ( float x, float y, float width, float height )
</syntaxhighlight>

=== Required Arguments ===
* '''x:''' An float representing the '''absolute''' origin X position of the rectangle, represented by pixels on the screen.
* '''y:''' An float representing the '''absolute''' origin Y position of the rectangle, represented by pixels on the screen.
* '''width:''' An float representing the width of the rectangle, drawn in a ''right'' direction from the origin.
* '''height:''' An float representing the height of the rectangle, drawn in a ''downwards'' direction from the origin.

=== Required Files ===
[https://cdn.discordapp.com/attachments/851000636484747274/861170045651910686/mta-helper.fx mta-helper.fx],
[https://cdn.discordapp.com/attachments/851000636484747274/861170037255307294/blurV.fx blurV.fx],
[https://cdn.discordapp.com/attachments/851000636484747274/861170034495455232/blurH.fx blurH.fx]

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

== Code ==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
local scx, scy = guiGetScreenSize()

Settings = {}
Settings.var = {}
Settings.var.blur = 1
Settings.var.optim = 4
Settings.screenRectangle = {}

local current

function createShader()
myScreenSource = dxCreateScreenSource( scx/Settings.var.optim, scy/Settings.var.optim )
blurHShader,tecName = dxCreateShader( "shaders/blurH.fx" )
blurVShader,tecName = dxCreateShader( "shaders/blurV.fx" )
bAllValid = myScreenSource and blurHShader and blurVShader
end
createShader()

function blur_createBlurRenctagle(bool)
if bool then
Settings.screenRectangle = {pos_x, pos_y, size_x, size_y}
createShader()
addEventHandler( "onClientHUDRender", root, blur_render2)
else
if isElement (blurHShader) and isElement (blurVShader) then
Settings.screenRectangle = {}
destroyElement (blurVShader)
destroyElement (blurHShader)
end
removeEventHandler( "onClientHUDRender", root, blur_render2)
end
end

function preRender ()
if not Settings.var then
return
end
RTPool.frameStart()
dxUpdateScreenSource( myScreenSource )
current = myScreenSource
current = applyGBlurH( current, Settings.var.blur )
current = applyGBlurV( current, Settings.var.blur )
dxSetRenderTarget()
end
addEventHandler ("onClientRender", root, preRender)

function dxDrawBluredRectangle (pos_x, pos_y, size_x, size_y, color)
if bAllValid then
dxDrawImageSection ( pos_x, pos_y, size_x, size_y, pos_x/Settings.var.optim, pos_y/Settings.var.optim, size_x/Settings.var.optim, size_y/Settings.var.optim, current, 0,0,0, color)
end
end

function applyGBlurH( Src, blur )
if not Src then return nil end
local mx,my = dxGetMaterialSize( Src )
local newRT = RTPool.GetUnused(mx,my)
if not newRT then return nil end
dxSetRenderTarget( newRT, true )
dxSetShaderValue( blurHShader, "TEX0", Src )
dxSetShaderValue( blurHShader, "TEX0SIZE", mx,my )
dxSetShaderValue( blurHShader, "BLUR", blur )
dxDrawImage( 0, 0, mx, my, blurHShader )
return newRT
end

function applyGBlurV( Src, blur )
if not Src then return nil end
local mx,my = dxGetMaterialSize( Src )
local newRT = RTPool.GetUnused(mx,my)
if not newRT then return nil end
dxSetRenderTarget( newRT, true )
dxSetShaderValue( blurVShader, "TEX0", Src )
dxSetShaderValue( blurVShader, "TEX0SIZE", mx,my )
dxSetShaderValue( blurVShader, "BLUR", blur )
dxDrawImage( 0, 0, mx,my, blurVShader )
return newRT
end

RTPool = {}
RTPool.list = {}

function RTPool.frameStart()
for rt,info in pairs(RTPool.list) do
info.bInUse = false
end
end

function RTPool.GetUnused( mx, my )
for rt,info in pairs(RTPool.list) do
if not info.bInUse and info.mx == mx and info.my == my then
info.bInUse = true
return rt
end
end

local rt = dxCreateRenderTarget( mx, my )
if rt then
RTPool.list[rt] = { bInUse = true, mx = mx, my = my }
end
return rt
end</syntaxhighlight>
</section>

== Example ==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
local scx, scy = guiGetScreenSize()

function drawBluredRectangle()
dxDrawBluredRectangle( scx/3.8, scy/3.8, scx/2.02, scy/2 )
end

addEventHandler("onClientRender", root, drawBluredRectangle)</syntaxhighlight>
</section>

===== Author: fiXlly, WaRuS =====