PT-BR/Sistema de eventos

O sistema de eventos é essencial quando se desenvolve scripts para MTA. Os eventos trabalham juntamente com a árvore de elementos.

O conceito de evento está presente não apenas no MTA, mas em vários lugares quando o assunto é programação. Um evento é chamado sempre que algo acontece - um jogador entra em um marcador, um jogador entra em um veículo, um elemento é clicado, um veículo explode e etc.

Sempre que, ao desenvolver um script, você pensar: "quando X acontecer, eu devo fazer Y", significa que você está pensando em eventos. "X" é um evento. "Quando o jogador morrer, eu devo mostrar uma mensagem no chat" significa que você precisa do evento que é emitido sempre que um jogador morre.

O MTA já possui vários eventos nativos que podem ser consultados em Eventos do Servidor e Eventos do Cliente. Mas você também pode criar os seus próprios eventos, se necessário.

Todo evento tem um source. O source (origem) é o elemento que originou o evento. O source pode ser um jogador, um marcador, um pedestre, um veículo e etc. Todo evento tem um source diferente, portanto, você consegue ver qual o source de um evento na página específica daquele evento.

Os manipuladores de eventos

Manipuladores de eventos são funções. Simples assim.

Sempre que um evento é emitido, o MTA percorre todos os recursos (resources) que estiverem rodando no seu servidor procurando pelos "manipuladores de eventos".

Os manipuladores de eventos (também conhecidos como Event Handlers) são funções simples que são chamadas sempre que aquele evento é emitido. Como os manipuladores de eventos são escritos por você, programador, você pode fazer o que quiser nestas funções.

Você liga um manipulador de evento a um evento usando o addEventHandler.

function myFunction()
	-- Aqui, dentro de #myFunction, podemos fazer o que quisermos.
	-- Podemos escrever mensagens, podemos criar um veículo, podemos spawnar o jogador em algum lugar...
	outputChatBox("Um novo player acabou de se conectar.")
end

-- Usando addEventHandler, nós dizemos que sempre que o evento "onPlayerConnect" for emitido, a função #myFunction() deve ser executada
addEventHandler("onPlayerConnect", getRootElement(), myFunction)

-- Também podemos declarar uma função direto no #addEventHandler, que é chamada quando "onVehicleExplode" for emitido
addEventHandler("onVehicleExplode", getRootElement(), function()
	outputChatBox("Socorro! Um veículo acaba de explodir! \o/")
end)

Propagação dos eventos

Os eventos, quando emitidos, se propagam pelo que chamamos de árvore de elementos. Isso quer dizer que quando um evento é emitido para um determinado elemento, o mesmo evento é emitido para os elementos pais e os elementos filhos. Sendo assim, se você emite um evento no elemento root da árvore de elementos, este evento será emitido para qualquer outro elemento existente (já que todos os elementos são filhos de root).

Alguns exemplos podem explicar melhor.

No exemplo abaixo, perceba que usamos getRootElement() no #addEventHandler. A função #getRootElement retorna o elemento root, que é pai de todos os outros. Sendo assim, o Event Handler será chamado sempre que qualquer carro no mapa explodir, já que todos os carros são filhos de root.

addEventHandler("onVehicleExplode", getRootElement(), function()
	outputChatBox("Um veículo qualquer acaba de explodir.")
end)

Já no exemplo abaixo, temos uma pequena modificação: agora, no #addEventHandler, nós não usamos mais o #getRootElement. Ao invés disso, nós usamos a variável vehicle que, por sua vez, possui como valor um veículo específico que nós criamos.

Sendo assim, o Event Handler só será chamado quando esse nosso veículo específico explodir. Diferente do exemplo anterior, que chamava o Event Handler sempre que qualquer veículo explodisse.

local vehicle = createVehicle(455, 0, 0, 0) 
addEventHandler("onVehicleExplode", vehicle, function()
	outputChatBox("Um veículo específico acaba de explodir.")
end)

[[{{{image}}}|link=|]]	Note: Esta página ainda está em processo de tradução

Each event handler has three 'hidden' variables:

• source: This is the element that the event originated from.
• this: This is the element that the handler is being triggered on (i.e. the one you attached it to with addEventHandler).
• eventName: This is the string of the name of the event that was called upon (i.e. the event name that was added with addEventHandler).

Additionally, the server-side event system also has one more 'hidden' variable:

• client: This is the client that triggered the event using triggerServerEvent. This is not set if the event was not triggered from a client.

The source variable is the most important one for most handlers. You almost always will want to reference this variable to tell what element triggered the event. The this variable has some uses for ensuring that an event was emitted by the element that you attached the handler to.

It is important to note that events follow the element hierachy. All events are initially triggered on the source element, followed by all the parent and children elements. This has few important implications:

• An event triggered on the root element will be triggered on every element in the element tree. This should be avoided where possible.
• All events anywhere in the element tree will be triggered on the root element. This means you can easily catch every event of a type by attaching a handler to the root element. Only do this if you genuinely want every event of that type, otherwise attach it somewhere more specific in the element tree.
• You can attach an event handler to your resource's root element to get all the events triggered by elements your resource contains.
• You can create 'dummy' elements to catch events from a group of child elements
• You can use dummy elements specified in a .map file (e.g. <flag>) and create 'real' representations for them (e.g. objects) and make these real elements children of the dummy element. Event handlers can then be attached to the dummy element and it will receive all the events of the real elements. This is useful for when one resource manages the representation of the element (creating the objects, for example), while another wants to handle special events. This could be a map resource that wants to handle a flag being captured in a specific way - the map resource would (generally) not be aware of the way the flag is represented. This doesn't matter as it can just attach handlers to it's dummy flag element while the other gamemode resource can handle the representation.

The function you attached to an event gets called and passed a bunch of arguments. These arguments are event-specific. Each event has specific parameters, for instance onClientGUIClick has 4 parameters, which are:

string button, string state, int absoluteX, int absoluteY

The function you attached to this event will be passed these parameters as arguments. You must remember that each event has different parameters.

Built in events

MTA has a number of built in events. These are listed on the pages Client Scripting Events and Scripting Events.

Custom events

You can create your own events that can be triggered across all resources. This is an important way to communicate with other resources and allow them to hook into your code. To add your own custom event, just call the addEvent function. You can then use the triggerEvent function to trigger that event any time you want - either using a timer, or based on a more general event.

For example, you could be making a Capture the Flag game mode and want to trigger an event when a player captures the flag. You could do this by attaching a event handler to the standard MTA onMarkerHit event and checking that the player entering the marker has the flag. if they do, you can then trigger your more specific onFlagCaptured event and other resources could handle this as they please.

Canceling

Events can be canceled with cancelEvent. This can have a variety of effects, but in general this means that the server will not perform whatever action it would usually do. For example, canceling onPickupUse would prevent a player being given what they tried to pick up, canceling onVehicleStartEnter would prevent the player entering the vehicle. You can check if the currently active event has been canceled using wasEventCanceled. It's important to note that canceling event does not prevent other event handlers being triggered.