Srslyyyy: Add onPlayerTriggerInvalidEvent by lopsi (https://github.com/multitheftauto/mtasa-blue/pull/3400)

2024-05-24T20:02:18Z

Add onPlayerTriggerInvalidEvent by lopsi (https://github.com/multitheftauto/mtasa-blue/pull/3400)

New page

__NOTOC__
{{Server event}}
{{Added feature/item|1.6.1|1.6.0|22459|This event is triggered whenever a player trigger invalid event on server-side.}}
It works for both non-added and non-remote events.

==Parameters==
<syntaxhighlight lang="lua">
string eventName, bool isAdded, bool isRemote
</syntaxhighlight>

*'''eventName''': An [[string]] representing event name.
*'''isAdded''': An [[bool]] representing whether called event is added.
*'''isRemote''': An [[bool]] representing whether called event is remote.
==Source==
The [[event system#Event source|source]] of this event is the [[player]] who triggered invalid event.

==Example==
This example allows you to kick/ban player which triggered invalid event.

<syntaxhighlight lang="lua">
local invalidEventCheckPunishment = true -- should player be punished upon detection (make sure that resource which runs this code has admin rights)
local eventCheckPunishmentBan = true -- only relevant if invalidEventCheckPunishment is set to true; use true for ban or false for kick
local eventCheckPunishmentReason = "Triggered invalid event" -- only relevant if invalidEventCheckPunishment is set to true; reason which would be shown to punished player
local eventCheckPunishedBy = "Console" -- only relevant if invalidEventCheckPunishment is set to true; who was responsible for punishing, as well shown to punished player
local eventCheckBanByIP = false -- only relevant if invalidEventCheckPunishment and eventCheckPunishmentBan is set to true; banning by IP nowadays is not recommended (...)
local eventCheckBanByUsername = false -- community username - legacy thing, hence is set to false and should stay like that
local eventCheckBanBySerial = true -- only relevant if invalidEventCheckPunishment and eventCheckPunishmentBan is set to true; (...) if there is a player serial to use instead
local eventCheckBanTime = 0 -- only relevant if invalidEventCheckPunishment and eventCheckPunishmentBan is set to true; time in seconds, 0 for permanent
local eventCheckDebugMessageLevel = 4 -- this debug level allows to hide INFO: prefix, and use custom colors
local eventCheckDebugMessageRed = 255 -- debug message - red color
local eventCheckDebugMessageGreen = 127 -- debug message - green color
local eventCheckDebugMessageBlue = 0 -- debug message - blue color

function onPlayerTriggerInvalidEvent(eventName, isAdded, isRemote)
local playerName = getPlayerName(source)
local eventAdded = isAdded and "yes" or "no"
local eventRemote = isRemote and "yes" or "no"
local eventActionTaken = (not invalidEventCheckPunishment and "none") or (eventCheckPunishmentBan and "ban" or "kick")
local eventLogText = "[Events]: "..playerName.." triggered invalid event '"..eventName.."' (event added: "..eventAdded..", event remote: "..eventRemote..", action taken: "..eventActionTaken..")"

outputDebugString(eventLogText, eventCheckDebugMessageLevel, eventCheckDebugMessageRed, eventCheckDebugMessageGreen, eventCheckDebugMessageBlue)

if (not invalidEventCheckPunishment) then
return false
end

if (eventCheckPunishmentBan) then
banPlayer(source, eventCheckBanByIP, eventCheckBanByUsername, eventCheckBanBySerial, eventCheckPunishedBy, eventCheckPunishmentReason, eventCheckBanTime)
else
kickPlayer(source, eventCheckPunishedBy, eventCheckPunishmentReason)
end
end
addEventHandler("onPlayerTriggerInvalidEvent", root, onPlayerTriggerInvalidEvent)
</syntaxhighlight>

{{See also/Server event|Player events}}

OnPlayerTriggerInvalidEvent - Revision history

Srslyyyy: Add onPlayerTriggerInvalidEvent by lopsi (https://github.com/multitheftauto/mtasa-blue/pull/3400)