Multi Theft Auto: Wiki - User contributions [en]

DgsGridListSetRowAsSection

2020-02-25T13:04:40Z

Konders: /* Syntax */ typo fix

{{Client function}}
__NOTOC__
This function sets whether the row is section.

==Syntax==
<syntaxhighlight lang="lua">
string dgsGridListSetRowAsSection( element gridlist, int row [, bool enable = false, bool enableClickAndSelect = false ] )
</syntaxhighlight>

===Required Arguments===
*'''gridlist:''' The dgs grid list you want to set.
*'''row:''' The row index of the grid list.

===Optional Arguments===
*'''enable:''' Whether the section mode enabled or not.
*'''enableClickAndSelect:''' Whether enable click and select.

===Returns===
Returns true if succeed, false otherwise

==Example==
<syntaxhighlight lang="lua">
DGS = exports.dgs
local playerList = DGS:dgsCreateGridList (346, 163, 433, 403, false ) --Create the grid list element
local column = DGS:dgsGridListAddColumn( playerList, "Player", 0.5 ) --Create a players column in the list
local row = DGS:dgsGridListAddRow ( playerList )
DGS:dgsGridListSetItemText ( playerList, row, column, "Player Name" )
DGS:dgsGridListSetRowAsSection ( playerList, row, true )

for id, player in ipairs(getElementsByType("player")) do
local row = DGS:dgsGridListAddRow ( playerList )
DGS:dgsGridListSetItemText ( playerList, row, column, getPlayerName ( player ) )
end
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

DxCreateRenderTarget

2020-02-16T06:23:21Z

Konders: Fixed example, now its works fine

{{Client function}}
__NOTOC__
This function creates a render target element, which is a special type of [[texture]] that can be drawn on with the dx functions. Successful render target creation is not guaranteed, and may fail due to hardware or memory limitations.

To see if creation is likely to fail, use [[dxGetStatus]]. (When '''VideoMemoryFreeForMTA''' is zero, failure ''is'' guaranteed.)
{{Tip|Use [[dxSetBlendMode]] to get better quality}}
{{Tip|It is highly recommended that [[dxSetTestMode]] is used when writing and testing scripts using dxCreateRenderTarget.}}
{{Note|Render targets are usually cleared when the player minimizes MTA (i.e. alt-tab). See [[onClientRestore]] for details on when to restore any fixed content.}}

==Syntax==
<syntaxhighlight lang="lua">
element dxCreateRenderTarget ( int width, int height [, bool withAlpha = false ] )
</syntaxhighlight>
{{OOP||[[Texture|DxRenderTarget]]}}
===Required Arguments===
*'''width :''' The width of the texture in pixels.
*'''height :''' The height of the texture in pixels.
*'''withAlpha:''' The render target will be created with an alpha channel. 'false' will turn images' alpha channels to black color

===Returns===
Returns a [[texture]] element if successful, ''false'' if the system is unable to create a render target.

'''You should always check to see if this function has returned false.'''

==Explanation==
What is a rendertarget?
A rendertarget is like a big, white paper(or if you set alpha to true, it will be a transparent paper) that you can draw on,
after you drawn on it, you can draw it as many times as you like, without impacting performance. It could be used for
dashboard, where a few hundred dxDraw* functions are called, so, instead of calling these every frame, you can just
draw it on a render target, and draw the render target, instead of every information one by one.

==Example==
<syntaxhighlight lang="lua">
local myRenderTarget = dxCreateRenderTarget(500, 500, true)
addEventHandler("onClientResourceStart", resourceRoot,
function()
myRenderTarget = dxCreateRenderTarget( 80, 100 ) -- Create a render target texture which is 80 x 100 pixels
end
)

addEventHandler( "onClientRender", root,
function()
if myRenderTarget then
dxSetRenderTarget( myRenderTarget ) -- Start drawing on myRenderTarget
dxDrawText ( "Hello", 10, 20 ) -- Draw a message
dxSetRenderTarget() -- Stop drawing on myRenderTarget

dxDrawImage( 50, 50, 100, 100, myRenderTarget ) -- Now use myRenderTarget as a material and draw it lots of times
dxDrawImage( 150, 350, 150, 100, myRenderTarget )
dxDrawImage( 250, 250, 100, 150, myRenderTarget )
dxDrawImage( 350, 30, 150, 150, myRenderTarget )
end
end
)

--
-- Function to draw text to our render target with '''modulate_add''' blend mode when the 'r' key is pressed
--
function updateRenderTarget()
dxSetRenderTarget(myRenderTarget, true)
dxSetBlendMode("modulate_add") -- Set 'modulate_add' when drawing stuff on the render target

dxDrawText("Testing "..getTickCount(), 0, 0, 0, 0, tocolor(255, 255, 255, 255), 2, "clear")

dxSetBlendMode("blend") -- Restore default blending
dxSetRenderTarget() -- Restore default render target
end
bindKey("r", "down", updateRenderTarget )

</syntaxhighlight>

==See Also==
{{Drawing_functions}}

[[hu:dxCreateRenderTarget]]

XmlLoadString

2020-02-01T12:44:59Z

Konders: fixed tags

__NOTOC__
{{Server client function}}
{{New feature/item|3.0160|1.5.7|19626|This function creates an [[Xmlnode]] from a string input.}}
==Syntax==
<syntaxhighlight lang="lua">
xmlnode xmlLoadString ( string xmlString )
</syntaxhighlight>
{{OOP|This function is a static function underneath the XML class.|[[XML]].loadstring||}}
===Required Arguments===
*'''xmlString:''' A string containing XML data

===Returns===
Returns the root [[xmlnode]] object of an xml string if successful, or ''false'' otherwise (invalid XML string).

==Example==
This example loads an XML string and loops the children while outputting to debugscript.
<syntaxhighlight lang="lua">
local rootNode = xmlLoadString("<animals test='x'><monkey name='crosroad'></monkey> <fox name='luxy'></fox></animals>")

if rootNode then
local rootAttributes = xmlNodeGetAttributes(rootNode)
print("Root Node", "Name: "..xmlNodeGetName(rootNode), "Attributes :"..toJSON(rootAttributes))

local children = xmlNodeGetChildren(rootNode)

for i, childNode in ipairs(children) do
local attributes = xmlNodeGetAttributes(childNode)
print("Child #"..i, "Name: "..xmlNodeGetName(childNode), "Attributes :"..toJSON(attributes))
end
end
</syntaxhighlight>

==See Also==
{{Shared xml functions}}
[[ru:xmlLoadString]]

XmlLoadString

2020-02-01T12:43:17Z

Konders: changed example

__NOTOC__
{{Server client function}}
{{New feature/item|3.0160|1.5.7|19626|This function creates an [[Xmlnode]] from a string input.}}
==Syntax==
<syntaxhighlight lang="lua">
xmlnode xmlLoadString ( string xmlString )
</syntaxhighlight>
{{OOP|This function is a static function underneath the XML class.|[[XML]].loadstring||}}
===Required Arguments===
*'''xmlString:''' A string containing XML data

===Returns===
Returns the root [[xmlnode]] object of an xml string if successful, or ''false'' otherwise (invalid XML string).

==Example==
This example loads an XML string and loops the children while outputting to debugscript.
<syntaxhighlight lang="lua">
local rootNode = xmlLoadString("<animals test='x'><monkey name='crosroad'></monkey> <fox name='luxy'></turtle></animals>")

if rootNode then
local rootAttributes = xmlNodeGetAttributes(rootNode)
print("Root Node", "Name: "..xmlNodeGetName(rootNode), "Attributes :"..toJSON(rootAttributes))

local children = xmlNodeGetChildren(rootNode)

for i, childNode in ipairs(children) do
local attributes = xmlNodeGetAttributes(childNode)
print("Child #"..i, "Name: "..xmlNodeGetName(childNode), "Attributes :"..toJSON(attributes))
end
end
</syntaxhighlight>

==See Also==
{{Shared xml functions}}
[[ru:xmlLoadString]]

Element/Effect

2019-01-25T15:32:41Z

Konders: /* Related scripting functions */

{{New items|3.0140|1.4|
The Effect class represents custom effect elements in the game world such as smoke, sparks, fire etc.

The element type of this class is '''"effect"'''.
}}

__TOC__
== Effects list ==
There are 82 effects.
<syntaxhighlight lang="lua">--A table containing all effect names.
local effectNames = {
"blood_heli","boat_prop","camflash","carwashspray","cement","cloudfast","coke_puff","coke_trail","cigarette_smoke",
"explosion_barrel","explosion_crate","explosion_door","exhale","explosion_fuel_car","explosion_large","explosion_medium",
"explosion_molotov","explosion_small","explosion_tiny","extinguisher","flame","fire","fire_med","fire_large","flamethrower",
"fire_bike","fire_car","gunflash","gunsmoke","insects","heli_dust","jetpack","jetthrust","nitro","molotov_flame",
"overheat_car","overheat_car_electric","prt_blood","prt_boatsplash","prt_bubble","prt_cardebris","prt_collisionsmoke",
"prt_glass","prt_gunshell","prt_sand","prt_sand2","prt_smokeII_3_expand","prt_smoke_huge","prt_spark","prt_spark_2",
"prt_splash","prt_wake","prt_watersplash","prt_wheeldirt","petrolcan","puke","riot_smoke","spraycan","smoke30lit","smoke30m",
"smoke50lit","shootlight","smoke_flare","tank_fire","teargas","teargasAD","tree_hit_fir","tree_hit_palm","vent","vent2",
"water_hydrant","water_ripples","water_speed","water_splash","water_splash_big","water_splsh_sml","water_swim","waterfall_end",
"water_fnt_tme","water_fountain","wallbust","WS_factorysmoke"
}</syntaxhighlight>
{|class="wikitable" style="text-align: center; font-size: 12px;"
|-
!width="150"|Name
!width="300"|Description


|-
|blood_heli
|bloody explosion
|-
|boat_prop
|a surf
|-
|camflash
|small flare
|-
|carwashspray
|steam, as on a carwash
|-
|cement
|cement
|-
|cloudfast
|fast clouds

|-
|coke_puff
|puff of a coke
|-
|coke_trail
|a pouring water
|-
|cigarette_smoke
|a smoke from a cigarette
|-
|explosion_barrel
|explosion and splinters of a box
|-
|explosion_crate
|explosion and splinters of the large box
|-
|explosion_door
|a smoke with sparks
|-
|exhale
|a small smoke
|-
|explosion_fuel_car
|explosion, as from the machine
|-
|explosion_large
|the large explosion
|-
|explosion_medium
|average explosion
|-
|explosion_molotov
|explosion, as from a molotov cocktail
|-
|explosion_small
|small explosion
|-
|explosion_tiny
|very small explosion
|-
|extinguisher
|foam of the fire extinguisher
|-
|flame
|small fire
|-
|fire
|fire
|-
|fire_med
|average fire
|-
|fire_large
|large fire
|-
|flamethrower
|fire of the flamethrower
|-
|fire_bike
|fire, as from a burning motorcycle
|-
|fire_car
|fire, as from the burning machine
|-
|gunflash
|as the bullet from a trunk takes off
|-
|gunsmoke
|a smoke from a gun
|-
|insects
|insects
|-
|heli_dust
|a dust, as from the helicopter
|-
|jetpack
|a jetpacks fire
|-
|jetthrust
|fire from the muffler of the machine, as during use of nitrogen
|-
|nitro
|nitro
|-
|molotov_flame
|fire from a Molotov Cocktail
|-
|overheat_car
|smoke from damaged car
|-
|overheat_car_electric
|wrecked electro-machine
|-
|prt_blood
|spark? maybe meant to be a mini red blood splash
|-
|prt_boatsplash
|foam
|-
|prt_bubble
|bubble
|-
|prt_cardebris
|splinters from a box
|-
|prt_collisionsmoke
|a dense white smoke
|-
|prt_glass
|a crashing glass
|-
|prt_gunshell
|shells
|-
|prt_sand
|sand, which was scattered
|-
|prt_sand2
|there is less sand, than in previous animation
|-
|prt_smokeII_3_expand
|a grey smoke
|-
|prt_smoke_huge
|there is a lot of grey smoke
|-
|prt_spark
|of a spark
|-
|prt_spark_2
|the large sparks
|-
|prt_splash
|burst
|-
|prt_wake
|a wave
|-
|prt_watersplash
|sparks
|-
|prt_wheeldirt
|sparks from wheels of the car
|-
|petrolcan
|a jet
|-
|puke
|belch
|-
|riot_smoke
|there is a lot of smoke
|-
|spraycan
|spray
|-
|smoke30lit
|a smoke
|-
|smoke30m
|a rich smoke
|-
|smoke50lit
|more richer smoke
|-
|shootlight
|a light being shot out (used for searchlights), sparks and glass
|-
|smoke_flare
|a light being shot out, sparks and glass, it makes a good firework effect
|-
|tank_fire
|a shot from the tank
|-
|teargas
|gas, as from gas grenade
|-
|teargasAD
|gas, as from small gas grenade
|-
|tree_hit_fir
|leaf falling
|-
|tree_hit_palm
|falling of pair large leafs
|-
|vent
|slowly dissipating a smoke
|-
|vent2
|practically too most
|-
|water_hydrant
|the large flow of water
|-
|water_ripples
|circles on water
|-
|water_speed
|the large sparks from water
|-
|water_splash
|small sparks from water
|-
|water_splash_big
|average sparks
|-
|water_splsh_sml
|sparks, only them it is not visible almost
|-
|water_swim
|small sparks at navigation
|-
|waterfall_end
|there is a lot of pair
|-
|water_fnt_tme
|the large flow of water
|-
|water_fountain
|water of a fountain
|-
|wallbust
|a disappearing heap pair
|-
|WS_factorysmoke
|smoke
|}

==Related scripting functions==
===Client===
* [[createEffect]]
* [[setEffectSpeed]]
* [[getEffectSpeed]]
* [[setEffectDensity]]
* [[getEffectDensity]]

[[Category:Element Types]]

[[hu:Element/Effect]]
[[ru:Element/Effect]]