Multi Theft Auto: Wiki - User contributions [en]

PT-BR/Introdução OOP

2025-02-08T00:45:37Z

Sousateew: Fix links

{{Nota|Se você contribuiu editando e ajustando esta página do fórum, se você se beneficiou deste tutorial ou se você tem algo a dizer; por favor, me dê um feedback no link do fórum fornecido abaixo.}}
Este é um tutorial de script que explica o que é programação orientada a objetos e ensina como usar os recursos de OOP (Programação Orientada a Objetos) do MTA. Isso foi originalmente criado por [[Usuário:Qais|qaisjp]] ([[Usuário Discussão:Qais|discussão]]) às 22h48min de 8 de junho de 2014 (UTC). [http://forum.mtasa.com/viewtopic.php?f=148&t=76388 Post no fórum.]

__TOC__
== Introdução à OOP ==
OOP (ou POO) significa ''programação orientada a objetos''. Três palavras simples e você provavelmente entenderá a última palavra mais. OOP é quando todas as funções relacionadas a uma única instância são chamadas nessa instância, sendo uma instância uma criação de uma classe - uma classe de elementos, uma classe de banco de dados, um jogador, um veículo. Originalmente, tudo era ''procedural'', você tinha que fazer coisas como:
<syntaxhighlight lang="lua">
local veiculo = createVehicle(411, 0, 0, 3)
setVehicleDamageProof(veiculo, true)
setElementFrozen(veiculo, true)
setElementHealth(veiculo, 1000)
setElementVelocity(veiculo, 0.2, 0.2, 0.2)
destroyElement(veiculo)
</syntaxhighlight>
Muitas vezes, você sabe com o que está lidando. A variável quase sempre está ligada ao tipo, você nomearia um veículo que explodiu como '''veiculoExplodido''', ou pelo menos no contexto você entenderia que '''explodido''' implica um veículo quando no evento '''onVehicleExplode'''. Então, você tem que escrever uma função longa ''e'' referenciar o veículo manualmente ao trabalhar de maneira procedural. Doloroso. A programação orientada a objetos é muito diferente disso e trabalha com cada "objeto" individualmente. Em vez de ter que chamar uma função e referenciá-la dentro da chamada, você na verdade chama a função DENTRO da classe.

Você provavelmente pensa que tudo o que você pode criar e passar para funções são elementos. Um veículo é um elemento. Um jogador é um elemento. Tudo o que é um elemento também é uma classe. Conexões criam uma instância de uma classe, mas "'''conexão'''" não é um elemento, é uma instância - um objeto. Ao longo do tutorial, quando eu digo ''objeto'', não me refiro a [[createObject]] (a menos que eu realmente mencione), mas para deixar as coisas mais claras, vou evitar mencionar objetos físicos enquanto escrevo este artigo. Aqui está um diagrama de Venn elegante que criei para mostrar a organização simples de classes e elementos.
[[Arquivo:Classes,_Elements_and_Problem_children.png|500px|esquerda|diagrama de Venn]]
As funções à esquerda são organizadas para mostrar em qual categoria o valor retornado se encaixa. Temos Classes, Elementos e "Problemas".
Problemas não são categorias reais escritas no código, apenas funções que quebram regras. Tudo com que você pode brincar são classes: recursos, veículos e equipes.
Todos os elementos são classes, você pode fazer: <syntaxhighlight lang="lua">destroyElement(ped)</syntaxhighlight> mas você não pode fazer: <syntaxhighlight lang="lua">destroyElement(resource)</syntaxhighlight>

Problemas são coisas estranhas. Você não pode fazer todas as funções mencionadas em (na verdade, todos os elementos não permitem a gama completa de funções a serem aplicadas a eles, mas mencionei especialmente algumas delas) na seção "Funções de Elemento" da lista de funções, mas você pode usar destroyElement() neles.
Existem filhos de classes, por exemplo, com jogadores, o sistema funciona assim: "''Elemento -> Pedestre -> Jogador''". Todos os Jogadores são Pedestres e todos os Pedestres são Elementos. Nem todos os Pedestres são Jogadores, e certamente nem todos os Elementos são Jogadores. O ponto principal aqui é que quase tudo o que você pode criar ou recuperar e reutilizar posteriormente usa uma classe.

Em vez do código anterior, o código poderia ser substituído por este:
<syntaxhighlight lang="lua">
local veiculo = createVehicle(411, 0, 0, 3)
veiculo:setDamageProof(true)
veiculo:setFrozen(true)
veiculo:setHealth(1000)
veiculo:setVelocity(0.2, 0.2, 0.2)
veiculo:destroy()
</syntaxhighlight>
Funciona de maneira bastante similar a como uma tabela funciona, é como customTable.setAlgo(), exceto que o uso de ''':''' faz o Lua converter customTable.setAlgo() para customTable.setAlgo(customTable). Isso é uma coisa interna sobre ''açúcar sintático'' e você não precisa se preocupar muito com isso.

Essas funções são bastante úteis, mas há mais mudanças com OOP, explicarei isso abaixo.

== Instanciação, variáveis ==
OOP remove a necessidade de dizer a parte "criar" da função, então em vez de dizer '''createVehicle''', você apenas diz '''Veiculo'''. Funciona exatamente da mesma maneira, é quase como fazer '''Veiculo = createVehicle'''. Legal, não é? A única diferença aqui é que você perde as coisas extras oferecidas, Veiculo não tem essas coisas extras, mas Jogador definitivamente tem. Por exemplo, em vez de fazer getPlayerFromName(), você faria Player.getFromName(). É uma maneira agradável e simples de organizar funções.
{{Dica|''Vehicle()'' funciona porque na verdade acessa a função '''createVehicle''', isso permite omitir o '''.criar''' quando se está simplesmente "criando um objeto"}}
Como a OOP se baseia na programação procedural, muitas coisas foram herdadas do estilo procedural, mas para facilitar as coisas, temos variáveis para todas as funções que exigem uma única entrada. Encurtamos '''getElementDimension()''' para '''elemento:getDimension()''', mas também podemos ir um nível mais profundo: '''elemento.dimension'''. Sim, como uma variável normal. Você pode definir essa variável como uma variável normal e ler dela como uma variável normal. Ei, vocêpoderia até fazer isso:
<syntaxhighlight lang="lua">function incrementarDimensao()
local jogador = Player.getRandom() -- pega um jogador aleatório
jogador.dimension = jogador.dimension + 1 -- incrementa a dimensão
end
setTimer(incrementarDimensao, 60*1000, 10) -- define um temporizador para sessenta mil milissegundos, sessenta segundos, um minuto
</syntaxhighlight>
Esse código pegaria um jogador aleatório e o moveria para a próxima dimensão a cada minuto pelos próximos dez minutos.

== Vetores ==
player.position também funciona! Mas como você muda três argumentos... usando uma variável? Vetores.
Vetores são classes muito poderosas e vêm em várias formas, para este introdução, vou abordar um vetor tridimensional em termos de elementos. Usar um vetor é muito simples e, é claro, opcional. Onde você pode usar posições atualmente, você pode usar um vetor.

Portanto, este é um exemplo simples de criar um veículo e movê-lo para o centro do mapa usando vetores:
<syntaxhighlight lang="lua">
-- Primeiro, crie um vetor tridimensional
local posicao = Vector3(300, -200, 2) -- algum lugar distante
local veiculo = Vehicle(411, posicao) -- crie um veículo na posição
veiculo.posicao = centreOfMap - Vetor3(300, -200, 0) -- mova o veículo duas unidades acima do centro do mapa
</syntaxhighlight>

Sim, usei o sinal negativo. Vetores não são apenas maneiras elegantes de lidar com posições ou rotações 3D ou qualquer coisa assim, você pode fazer cálculos matemáticos com eles. A matemática ''especial'' ainda não foi documentada, mas vou tentar trabalhar nisso. Portanto, como você pode ver na linha um, criei um vetor 3D em ''300, -200, 2'' e na linha dois criei o veículo nessa posição.

'''veiculo.position''' retornou um vetor e também aceita um vetor - é praticamente setElementPosition() sem o "()". Apenas uma variável simples; então, na linha três, eu mudei o valor do vetor da posição do veículo. É aqui que a matemática aconteceu, em termos simples é isso que está acontecendo:
<syntaxhighlight lang="lua">
x = 300 - 300
y = -200 - -200
z = 2 - 0
</syntaxhighlight>

A matemática de vetores é um pouco complicada, mas definitivamente permite uma grande variedade de mágicas matemáticas. Confira os links úteis abaixo relacionados a Vetores e Matrizes (Matrizes = forma plural de Matriz) para entender mais sobre como isso funciona.

== Entendendo a documentação ==
A documentação para a sintaxe de OOP tem a intenção de ser muito simples e é suportada pela sintaxe procedural. Para simplificar as coisas, tudo é formatado de maneira consistente de certa forma.

<section name="Exemplo" class="generic" show="true">
{{OOP|Defina a variável como nula para executar [[removePedFromVehicle]]|[[ped]]:warpIntoVehicle|vehicle|getPedOccupiedVehicle}}
</section>
Às vezes, uma nota é adicionada à página. Isso explicará quaisquer diferenças especiais no uso de OOP para essa função.
Os métodos podem começar com ''[[player]]:'' ou ''[[Player]].'' - o primeiro é apenas para uma função em uma instância (setElementHealth) e o último é um método estático (getRandomPlayer).
A seção de contraparte permite ver rapidamente como a variável pode ser usada. Na maioria dos casos, isso pode ser inferido a partir da página da função.
Se você é um contribuidor do wiki, considere também ler [[Template:OOP|o modelo de OOP]].

== Links úteis ==
Outras páginas relacionadas úteis sobre OOP:

* [[OOP]]
* [[Vector]]
* [[Matrix]]

[[Category:OOP]]
[[Category:Incomplete]]
[[Category:Tutorials]]

[[hu:OOP Introdução]]
''Translated by'': Sousateew ([https://wiki.multitheftauto.com/wiki/OOP_Introduction Original])

IsPedReloadingWeapon

2025-01-15T21:52:27Z

Sousateew: Undo revision 81733 by Sousateew (talk)

__NOTOC__
{{Shared function}}
{{New feature/item|3.0156|1.5.5|11856|
This function is used to determine whether or not a ped is currently reloading their weapon. Useful to stop certain quick reload exploits.}}

==Syntax==
<syntaxhighlight lang="lua">
bool isPedReloadingWeapon ( ped thePed )
</syntaxhighlight>
{{OOP||[[ped]]:isReloadingWeapon|reloadingWeapon}}

===Required Arguments===
*'''thePed:''' The [[ped]] you are checking.

===Returns===
Returns ''true'' if the ped is currently reloading a weapon, ''false'' otherwise.

==Example==
<section name="Client" class="client" show="true">
This example checks if the player who enters the ''/amireloading'' command is reloading and outputs a message.
<syntaxhighlight lang="lua">
function isHeReloading( )
if isPedReloadingWeapon( localPlayer ) then
outputChatBox( "You are reloading a weapon" )
else
outputChatBox( "No, you're not reloading a weapon" )
end
end
addCommandHandler( "amireloading", isHeReloading )
</syntaxhighlight></section>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.6.0-22909|Added to the server side, the function is now shared}}

==See Also==
{{Ped functions}}

IsPedReloadingWeapon

2025-01-15T21:50:44Z

Sousateew: Fix side

__NOTOC__
{{Client function}}
{{New feature/item|3.0156|1.5.5|11856|
This function is used to determine whether or not a ped is currently reloading their weapon. Useful to stop certain quick reload exploits.}}

==Syntax==
<syntaxhighlight lang="lua">
bool isPedReloadingWeapon ( ped thePed )
</syntaxhighlight>
{{OOP||[[ped]]:isReloadingWeapon|reloadingWeapon}}

===Required Arguments===
*'''thePed:''' The [[ped]] you are checking.

===Returns===
Returns ''true'' if the ped is currently reloading a weapon, ''false'' otherwise.

==Example==
<section name="Client" class="client" show="true">
This example checks if the player who enters the ''/amireloading'' command is reloading and outputs a message.
<syntaxhighlight lang="lua">
function isHeReloading( )
if isPedReloadingWeapon( localPlayer ) then
outputChatBox( "You are reloading a weapon" )
else
outputChatBox( "No, you're not reloading a weapon" )
end
end
addCommandHandler( "amireloading", isHeReloading )
</syntaxhighlight></section>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.6.0-22909|Added to the server side, the function is now shared}}

==See Also==
{{Ped functions}}

User:Sousateew

2024-11-06T23:39:35Z

Sousateew: Created page with "Hello! I'm [https://instagram.com/sousateew Thiago Coutinho]. Know my work visiting [https://github.com/sousateew GitHub]."

Hello!
I'm [https://instagram.com/sousateew Thiago Coutinho].
Know my work visiting [https://github.com/sousateew GitHub].

PT-BR/Introdução OOP

2023-08-19T00:30:16Z

Sousateew: Created page with "{{Nota|Se você contribuiu editando e ajustando esta página do fórum, se você se beneficiou deste tutorial ou se você tem algo a dizer; por favor, me dê um feedback no link do fórum fornecido abaixo.}} Este é um tutorial de script que explica o que é programação orientada a objetos e ensina como usar os recursos de OOP (Programação Orientada a Objetos) do MTA. Isso foi originalmente criado por qaisjp (discussão)..."

{{Nota|Se você contribuiu editando e ajustando esta página do fórum, se você se beneficiou deste tutorial ou se você tem algo a dizer; por favor, me dê um feedback no link do fórum fornecido abaixo.}}
Este é um tutorial de script que explica o que é programação orientada a objetos e ensina como usar os recursos de OOP (Programação Orientada a Objetos) do MTA. Isso foi originalmente criado por [[Usuário:Qais|qaisjp]] ([[Usuário Discussão:Qais|discussão]]) às 22h48min de 8 de junho de 2014 (UTC). [http://forum.mtasa.com/viewtopic.php?f=148&t=76388 Post no fórum.]

__TOC__
== Introdução à OOP ==
OOP (ou POO) significa ''programação orientada a objetos''. Três palavras simples e você provavelmente entenderá a última palavra mais. OOP é quando todas as funções relacionadas a uma única instância são chamadas nessa instância, sendo uma instância uma criação de uma classe - uma classe de elementos, uma classe de banco de dados, um jogador, um veículo. Originalmente, tudo era ''procedural'', você tinha que fazer coisas como:
<syntaxhighlight lang="lua">
local veiculo = createVehicle(411, 0, 0, 3)
setVehicleDamageProof(veiculo, true)
setElementFrozen(veiculo, true)
setElementHealth(veiculo, 1000)
setElementVelocity(veiculo, 0.2, 0.2, 0.2)
destroyElement(veiculo)
</syntaxhighlight>
Muitas vezes, você sabe com o que está lidando. A variável quase sempre está ligada ao tipo, você nomearia um veículo que explodiu como '''veiculoExplodido''', ou pelo menos no contexto você entenderia que '''explodido''' implica um veículo quando no evento '''onVehicleExplode'''. Então, você tem que escrever uma função longa ''e'' referenciar o veículo manualmente ao trabalhar de maneira procedural. Doloroso. A programação orientada a objetos é muito diferente disso e trabalha com cada "objeto" individualmente. Em vez de ter que chamar uma função e referenciá-la dentro da chamada, você na verdade chama a função DENTRO da classe.

Você provavelmente pensa que tudo o que você pode criar e passar para funções são elementos. Um veículo é um elemento. Um jogador é um elemento. Tudo o que é um elemento também é uma classe. Conexões criam uma instância de uma classe, mas "'''conexão'''" não é um elemento, é uma instância - um objeto. Ao longo do tutorial, quando eu digo ''objeto'', não me refiro a [[createObject]] (a menos que eu realmente mencione), mas para deixar as coisas mais claras, vou evitar mencionar objetos físicos enquanto escrevo este artigo. Aqui está um diagrama de Venn elegante que criei para mostrar a organização simples de classes e elementos.
[[Arquivo:Classes,_Elements_and_Problem_children.png|500px|esquerda|diagrama de Venn]]
As funções à esquerda são organizadas para mostrar em qual categoria o valor retornado se encaixa. Temos Classes, Elementos e "Problemas".
Problemas não são categorias reais escritas no código, apenas funções que quebram regras. Tudo com que você pode brincar são classes: recursos, veículos e equipes.
Todos os elementos são classes, você pode fazer: <syntaxhighlight lang="lua">destroyElement(ped)</syntaxhighlight> mas você não pode fazer: <syntaxhighlight lang="lua">destroyElement(resource)</syntaxhighlight>

Problemas são coisas estranhas. Você não pode fazer todas as funções mencionadas em (na verdade, todos os elementos não permitem a gama completa de funções a serem aplicadas a eles, mas mencionei especialmente algumas delas) na seção "Funções de Elemento" da lista de funções, mas você pode usar destroyElement() neles.
Existem filhos de classes, por exemplo, com jogadores, o sistema funciona assim: "''Elemento -> Pedestre -> Jogador''". Todos os Jogadores são Pedestres e todos os Pedestres são Elementos. Nem todos os Pedestres são Jogadores, e certamente nem todos os Elementos são Jogadores. O ponto principal aqui é que quase tudo o que você pode criar ou recuperar e reutilizar posteriormente usa uma classe.

Em vez do código anterior, o código poderia ser substituído por este:
<syntaxhighlight lang="lua">
local veiculo = createVehicle(411, 0, 0, 3)
veiculo:setDamageProof(true)
veiculo:setFrozen(true)
veiculo:setHealth(1000)
veiculo:setVelocity(0.2, 0.2, 0.2)
veiculo:destroy()
</syntaxhighlight>
Funciona de maneira bastante similar a como uma tabela funciona, é como customTable.setAlgo(), exceto que o uso de ''':''' faz o Lua converter customTable.setAlgo() para customTable.setAlgo(customTable). Isso é uma coisa interna sobre ''açúcar sintático'' e você não precisa se preocupar muito com isso.

Essas funções são bastante úteis, mas há mais mudanças com OOP, explicarei isso abaixo.

== Instanciação, variáveis ==
OOP remove a necessidade de dizer a parte "criar" da função, então em vez de dizer '''createVehicle''', você apenas diz '''Veiculo'''. Funciona exatamente da mesma maneira, é quase como fazer '''Veiculo = createVehicle'''. Legal, não é? A única diferença aqui é que você perde as coisas extras oferecidas, Veiculo não tem essas coisas extras, mas Jogador definitivamente tem. Por exemplo, em vez de fazer getPlayerFromName(), você faria Player.getFromName(). É uma maneira agradável e simples de organizar funções.
{{Dica|''Vehicle()'' funciona porque na verdade acessa a função '''createVehicle''', isso permite omitir o '''.criar''' quando se está simplesmente "criando um objeto"}}
Como a OOP se baseia na programação procedural, muitas coisas foram herdadas do estilo procedural, mas para facilitar as coisas, temos variáveis para todas as funções que exigem uma única entrada. Encurtamos '''getElementDimension()''' para '''elemento:getDimension()''', mas também podemos ir um nível mais profundo: '''elemento.dimension'''. Sim, como uma variável normal. Você pode definir essa variável como uma variável normal e ler dela como uma variável normal. Ei, vocêpoderia até fazer isso:
<syntaxhighlight lang="lua">function incrementarDimensao()
local jogador = Player.getRandom() -- pega um jogador aleatório
jogador.dimension = jogador.dimension + 1 -- incrementa a dimensão
end
setTimer(incrementarDimensao, 60*1000, 10) -- define um temporizador para sessenta mil milissegundos, sessenta segundos, um minuto
</syntaxhighlight>
Esse código pegaria um jogador aleatório e o moveria para a próxima dimensão a cada minuto pelos próximos dez minutos.

== Vetores ==
player.position também funciona! Mas como você muda três argumentos... usando uma variável? Vetores.
Vetores são classes muito poderosas e vêm em várias formas, para este introdução, vou abordar um vetor tridimensional em termos de elementos. Usar um vetor é muito simples e, é claro, opcional. Onde você pode usar posições atualmente, você pode usar um vetor.

Portanto, este é um exemplo simples de criar um veículo e movê-lo para o centro do mapa usando vetores:
<syntaxhighlight lang="lua">
-- Primeiro, crie um vetor tridimensional
local posicao = Vector3(300, -200, 2) -- algum lugar distante
local veiculo = Vehicle(411, posicao) -- crie um veículo na posição
veiculo.posicao = centreOfMap - Vetor3(300, -200, 0) -- mova o veículo duas unidades acima do centro do mapa
</syntaxhighlight>

Sim, usei o sinal negativo. Vetores não são apenas maneiras elegantes de lidar com posições ou rotações 3D ou qualquer coisa assim, você pode fazer cálculos matemáticos com eles. A matemática ''especial'' ainda não foi documentada, mas vou tentar trabalhar nisso. Portanto, como você pode ver na linha um, criei um vetor 3D em ''300, -200, 2'' e na linha dois criei o veículo nessa posição.

'''veiculo.position''' retornou um vetor e também aceita um vetor - é praticamente setElementPosition() sem o "()". Apenas uma variável simples; então, na linha três, eu mudei o valor do vetor da posição do veículo. É aqui que a matemática aconteceu, em termos simples é isso que está acontecendo:
<syntaxhighlight lang="lua">
x = 300 - 300
y = -200 - -200
z = 2 - 0
</syntaxhighlight>

A matemática de vetores é um pouco complicada, mas definitivamente permite uma grande variedade de mágicas matemáticas. Confira os links úteis abaixo relacionados a Vetores e Matrizes (Matrizes = forma plural de Matriz) para entender mais sobre como isso funciona.

== Entendendo a documentação ==
A documentação para a sintaxe de OOP tem a intenção de ser muito simples e é suportada pela sintaxe procedural. Para simplificar as coisas, tudo é formatado de maneira consistente de certa forma.

<section name="Exemplo" class="generic" show="true">
{{OOP|Defina a variável como nula para executar [[removePedFromVehicle]]|[[ped]]:warpIntoVehicle|vehicle|getPedOccupiedVehicle}}
</section>
Às vezes, uma nota é adicionada à página. Isso explicará quaisquer diferenças especiais no uso de OOP para essa função.
Os métodos podem começar com ''[[player]]:'' ou ''[[Player]].'' - o primeiro é apenas para uma função em uma instância (setElementHealth) e o último é um método estático (getRandomPlayer).
A seção de contraparte permite ver rapidamente como a variável pode ser usada. Na maioria dos casos, isso pode ser inferido a partir da página da função.
Se você é um contribuidor do wiki, considere também ler [[Template:OOP|o modelo de OOP]].

== Links úteis ==
Outras páginas relacionadas úteis sobre OOP:

[[OOP]]
[[Vetor]]
[[Matriz]]
[[Categoria:OOP]]
[[Categoria:Incompleto]]
[[Categoria:Tutoriais]]

[[hu:OOP Introdução]]
[[zh-cn:Introdução à OOP]]

''Translated by'': Sousateew ([https://wiki.multitheftauto.com/wiki/OOP_Introduction Original])

DxDrawDiamond

2023-08-18T02:13:10Z

Sousateew:

{{Useful Function}}
This function create a diamond

==Syntax==
<syntaxhighlight lang="lua">bool dxDrawDiamond(x,y,w,tocolor)</syntaxhighlight>

===Required Arguments===
* '''x''': An integer representing the absolute starting X position of the line, represented in pixels on the screen.
* '''y''': An integer representing the absolute starting Y position of the line, represented in pixels on the screen.
* '''w''': An integer representing the absolute starting width of the line, represented in pixels on the screen.
* '''tocolor''': Represents a color produced by [[tocolor]] or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).

==Code==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function dxDrawDiamond(x, y, w, tocolor)
local i = 1;
while (w-i*2) > 0 do
dxDrawRectangle(x+i,y-i,w-i*2,1,tocolor)
dxDrawRectangle(x+i,y+i-1,w-i*2,1,tocolor)
i = i + 1
end
end
</syntaxhighlight>
</section>
[[File:Rombo.JPG|thumb|Example of how it should looks like.||200x203px]]

==Example==
<syntaxhighlight lang="lua">
addEventHandler('onClientRender', root,
function()
dxDrawDiamond(401, 268, 150, tocolor(0, 0, 0, 180))
end
)
</syntaxhighlight>

''Author'': ClawSuit
''Translated by'': Sousateew

==See Also==
{{Useful_Functions}}

DxDrawDiamond

2023-08-18T00:05:18Z

Sousateew: Create (eS/dxDrawRombo by ClawSuit)

{{Useful Function}}
This function create a diamond

==Syntax==
<syntaxhighlight lang="lua">bool dxDrawDiamond(x,y,w,tocolor)</syntaxhighlight>

===Required Arguments===
* '''x''': An integer representing the absolute starting X position of the line, represented in pixels on the screen.
* '''y''': An integer representing the absolute starting Y position of the line, represented in pixels on the screen.
* '''w''': An integer representing the absolute starting width of the line, represented in pixels on the screen.
* '''tocolor''': Represents a color produced by [[tocolor]] or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).

==Code==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function dxDrawDiamond(x, y, w, tocolor)
local i = 1;
while (w-i*2) > 0 do
dxDrawRectangle(x+i,y-i,w-i*2,1,tocolor)
dxDrawRectangle(x+i,y+i-1,w-i*2,1,tocolor)
i = i + 1
end
end
</syntaxhighlight>
</section>

==Example==
<syntaxhighlight lang="lua">
addEventHandler('onClientRender', root,
function()
dxDrawDiamond(401, 268, 150, tocolor(0, 0, 0, 180))
end
)
</syntaxhighlight>
[[File:Rombo.JPG|thumb|Example of how it should looks like.||200x203px]]

''Author'': ClawSuit
''Translated by'': Sousateew

==See Also==
{{Useful_Functions}}

DxDrawImage

2023-01-23T21:40:03Z

Sousateew:

__NOTOC__
{{Client function}}

[[Image:MTAsa dxDrawImage.png|thumb|190px|An image drawn on the screen with the dxDrawImage 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]]).<br/>
Image files should ideally have dimensions that are a power of two, to prevent possible blurring.<br/>
<b>Power of two: 2px, 4px, 8px, 16px, 32px, 64px, 128px, 256px, 512px, 1024px...</b>

{{Tip|Use a texture created with [[dxCreateTexture]] to '''speed up drawing'''.}}
{{Tip|To help prevent edge artifacts when drawing textures, set '''textureEdge''' to '''"clamp"''' when calling [[dxCreateTexture]]}}
==Syntax==
<syntaxhighlight lang="lua">
bool dxDrawImage ( float posX, float posY, float width, float height, mixed image,
[ float rotation = 0, float rotationCenterOffsetX = 0, float rotationCenterOffsetY = 0,
int color = tocolor(255,255,255,255), 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
*'''height:''' the absolute height of the image
*'''image:''' Either a [[material]] element or a [[filepath]] of the image which is going to be drawn. (.dds images are also supported). Image files should ideally have dimensions that are a power of two, to prevent possible blurring. Use a texture created with [[dxCreateTexture]] to '''speed up drawing'''.

===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:''' Tints the image with a value produced by [[tocolor]] or hexadecimal number in format: 0xAARRGGBB (RR = red, GG = green, BB = blue, AA = alpha).
*'''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==
Example of a pendulum swinging from the top of the screen, made using dxDrawImage.
<syntaxhighlight lang="lua">
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
addEventHandler("onClientRender", root, renderDisplay) -- Keep everything visible with onClientRender.
</syntaxhighlight>

==See Also==
{{Drawing_functions}}

[[hu:dxDrawImage]]

GetSoundWaveData

2023-01-03T06:09:05Z

Sousateew: "if ( waveData )" in for?

__NOTOC__
{{Client function}}
This function gets the wave form data for an audio stream which is a table of floats representing the current audio frame as a wave.
This allows things like visualisations.

{{New feature/item|3.0132|1.3.2||
If the element is a player, this function will use the players voice.
}}
==Syntax==
<syntaxhighlight lang="lua">table getSoundWaveData ( element sound, int iSamples )</syntaxhighlight>
{{OOP||[[sound]]:getWaveData}}
===Required Arguments===
*'''sound:''' a [[sound]] [[element]] that is created using [[playSound]] or [[playSound3D]]. Streams are also supported
*'''iSamples:''' allowed samples are 256, 512, 1024, 2048, 4096, 8192 and 16384.

===Returns===
Returns a [[table]] of '''iSamples''' ''floats'' representing the current audio frame waveform.
Returns ''false'' if the sound is not playing yet or hasn't buffered in the
case of streams.

==Example==
This example creates a sound visualizer on the top left corner of the screen.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
soundHandler = playSound ( "sound.wav" )

function onSoundPlayRender ( )
if ( soundHandler ) then
local waveData = getSoundWaveData ( soundHandler, 256 )
if ( waveData ) then
for i=0,255 do
dxDrawRectangle ( i, 128, 1, waveData[i] * 128)
end
end
end
end
addEventHandler ( "onClientRender", getRootElement(), onSoundPlayRender )
</syntaxhighlight>
</section>
This example creates a sound viewer, but only with bars down.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
soundHandler = playSound ("audio.mp3")
local samples = 256

function renderWave ()
if (isElement (soundHandler)) then
local waveData = getSoundWaveData (soundHandler, samples)
if (waveData) then -- Avoid NaN values.
for i=0, samples-1 do
dxDrawRectangle (i, 128, 1, math.abs (waveData[i]) * 128)
end
end
end
end
addEventHandler ("onClientRender", root, renderWave)
</syntaxhighlight>
</section>
This example creates a sound viewer, but only with bars up.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
soundHandler = playSound ("audio.mp3")
local samples = 256

function renderWave ()
if (isElement (soundHandler)) then
local waveData = getSoundWaveData (soundHandler, samples)
if (waveData) then -- Avoid NaN values.
for i=0, samples-1 do
dxDrawRectangle (i, 128, 1, math.abs (waveData[i]) * -128)
end
end
end
end
addEventHandler ("onClientRender", root, renderWave)
</syntaxhighlight>
</section>
This example creates a sound viewer on the bottom right corner of the screen.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
soundHandler = playSound ("audio.mp3")
local x, y = guiGetScreenSize ()
local samples = 256

function renderWave ()
if (isElement (soundHandler)) then
local waveData = getSoundWaveData (soundHandler, samples)
if (waveData) then -- Avoid NaN values.
for i=0, samples-1 do
dxDrawRectangle ((x-samples)+i, y-128, 1, waveData[i] * 128)
end
end
end
end
addEventHandler ("onClientRender", root, renderWave)
</syntaxhighlight>
</section>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.2|Added player element to use a players voice}}

==See Also==
{{Client_audio_functions}}

[[hu:getSoundWaveData]]
[[ar:getSoundWaveData]]
[[pt-br:getSoundWaveData]]