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
 
(20 intermediate revisions by 10 users not shown)
Line 5: Line 5:
==Parameters==
==Parameters==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
string theIPOrSerial
ban theBan
</syntaxhighlight>  
</syntaxhighlight>  


*'''theIPOrSerial''': The IP address or serial that was banned from the server.
*'''theBan''': the [[ban]] which was added.


<!-- Add the event's source in the section below -->
==Source==
==Source==
The [[event system#Event source|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.
The [[event system#Event source|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.


<!-- Only include this section below if cancelling the event has any effect. If you don't know if it does, ask a dev! -->
==Cancel effect==
==Cancel effect==
If this event is [[Event system#Canceling|canceled]], the requested ban is not performed.
This event cannot be canceled.


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
This example outputs a simple message to all players when a player added a ban.
This example does...
<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--This line does...
function announceBan( theBan )
blah()
  if ( isElement( source ) ) and ( getElementType( source ) == "player" ) then -- Check if the element responsible for the ban is a player element
--This line does this...
outputChatBox( getPlayerName( source ) .. " banned " .. ( getBanSerial( theBan ) or getBanIP( theBan ) ) ) -- Output to the chatbox saying the player has banned the IP/Serial
mooo
  end
end
addEventHandler( "onBan", root, announceBan ) -- Adds the event handler for "onBan" and must be bound to root
</syntaxhighlight>
</syntaxhighlight>


==See Also==
{{See also/Server event|Server events}}
{{Event_functions}}
[[Category:Needs Example]]

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"