RU/cancelEvent

Эта функция используется для остановки автоматической внутренней обработки событий, например, её можно использовать, чтобы предотвратить передачу предмета игроку, когда он проходит мимо пикапа, путём отмены события onPickupUse.

Данная функция не влияет на все события. Для получения информации о том, что происходит при отмене события, смотрите страницы отдельных событий. Данная функция не останавливает вызов дальнейших обработчиков событий, поскольку порядок вызова обработчиков событий во многих случаях не определён. Вместо этого вы можете увидеть, было ли отменено текущее активное событие, используя wasEventCancelled.

Использование события отмены вне обработчика событий не имеет никакого эффекта.

Если вы реализуете свои собственные пользовательские события и хотите обработать их отмену, вам следует вызвать wasEventCancelled для проверки после вашего вызова triggerEvent.

Синтаксис

Click to collapse [-]

Server

bool cancelEvent( [bool cancel = true, string reason = ""] )   

Click to collapse [-]

Client

bool cancelEvent( )   

Необязательные аргументы

Примечание. При использовании необязательных аргументов Вам может потребоваться предоставить все аргументы перед тем аргументом, который Вы хотите использовать. Для более подробной информации ознакомьтесь с необязательными аргументами.

• cancel: Значение true для отмены события, значение false для отмены отмены события.
• reason: Причина отмены события.

Возвращаемые значения

• true всегда.

Пример использования

Click to collapse [-]

Сервер

Пример 1. Этот пример не позволяет игроку войти в транспортное средство.

function startEnterVehicle()
   cancelEvent()
end
addEventHandler("onVehicleStartEnter", root, startEnterVehicle)

Click to collapse [-]

Клиент

Пример 1. Этот пример предотвращает любой ущерб игроку на клиентской стороне.

function clientPlayerDamage()
	cancelEvent()
end
addEventHandler("onClientPlayerDamage", root, clientPlayerDamage)

Смотрите также

Серверные функции

• getCancelReason - получает причину отмены события
• triggerClientEvent - позволяет вызвать срабатывание события, предварительно созданного на клиенте
• triggerLatentClientEvent - аналог triggerClientEvent, но скорость передачи может быть ограничена

Клиентские функции

• triggerLatentServerEvent - аналог triggerServerEvent, но скорость передачи может быть ограничена
• triggerServerEvent - позволяет вызвать срабатывание события, предварительно созданного на сервере

Общие функции

• addEvent - позволяет зарегистрировать своё собственное событие
• addEventHandler - прикрепляет к событию обработчик
• cancelEvent - останавливает автоматическую внутреннюю обработку события
• cancelLatentEvent - останавливает автоматическую внутреннюю обработку скрытого события
• getEventHandlers - получает прикреплённые функции из события и присоединённый элемент из текущего lua-скрипта
• getLatentEventHandles - получает текущие скрытые события в очереди
• getLatentEventStatus - получает состояние одного скрытого события в очереди
• removeEventHandler - открепляет от события обработчик
• triggerEvent - вызывает срабатывание указанного события для указанного элемента в дереве элементов
• wasEventCancelled - проверяет, было ли отменено последнее завершённое событие