OnBan: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (Reverted edits by Violence (talk) to last revision by Botder)
Tag: Rollback
 
(11 intermediate revisions by 4 users not shown)
Line 8: Line 8:
</syntaxhighlight>  
</syntaxhighlight>  


*'''theBan ''': The [[ban]] which was added.
*'''theBan''': the [[ban]] which was added.


==Source==
==Source==
Line 20: Line 20:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function announceBan( theBan )
function announceBan( theBan )
if getElementType( source ) then --Check if a player banned the IP/Serial
  if ( isElement( source ) ) and ( getElementType( source ) == "player" ) then -- Check if the element responsible for the ban is a player element
outputChatBox( getPlayerName( source ) .. " banned " .. ( getBanSerial(theBan) or getBanIP(theBan) ) ) --Output to the chatbox saying the player has banned the IP/Serial
outputChatBox( getPlayerName( source ) .. " banned " .. ( getBanSerial( theBan ) or getBanIP( theBan ) ) ) -- Output to the chatbox saying the player has banned the IP/Serial
end
  end
end
end
 
addEventHandler( "onBan", root, announceBan ) -- Adds the event handler for "onBan" and must be bound to root
addEventHandler( "onBan", root, announceBan ) --Adds the event handler for 'onBan' and must be bound to root
</syntaxhighlight>
</syntaxhighlight>


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

Latest revision as of 14:11, 22 August 2020

This event is triggered when an IP address or serial is banned from the server.

Parameters

ban theBan
  • theBan: the ban which was added.

Source

The source of this event is the element that was responsible for the banning. If no responsible was specified, the source is the global root element.

Cancel effect

This event cannot be canceled.

Example

This example outputs a simple message to all players when a player added a ban. 

function announceBan( theBan )
   if ( isElement( source ) ) and ( getElementType( source ) == "player" ) then -- Check if the element responsible for the ban is a player element
	outputChatBox( getPlayerName( source ) .. " banned " .. ( getBanSerial( theBan ) or getBanIP( theBan ) ) ) -- Output to the chatbox saying the player has banned the IP/Serial
   end
end
addEventHandler( "onBan", root, announceBan ) -- Adds the event handler for "onBan" and must be bound to root

See Also

Server events


Event functions


Retrieved from "https://wiki.multitheftauto.com/wiki/OnBan?oldid=67290"