OnBan: Difference between revisions
Jump to navigation
Jump to search
m (Improving) |
m (Improving) |
||
Line 17: | Line 17: | ||
==Example== | ==Example== | ||
This example outputs a simple message to | This example outputs a simple message to all players when a player added a ban. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function announceBan( theBan ) | function announceBan( theBan ) |
Revision as of 16:57, 28 September 2011
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
If this event is canceled, the requested ban is not performed.
Example
This example outputs a simple message to all players when a player added a ban.
function announceBan( theBan ) if getElementType( source ) then --Check if a player 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 addEventHandler( "onBan", root, announceBan ) --Adds the event handler for 'onBan' and must be bound to root
See Also
Server events
Event functions
- addEvent
- addEventHandler
- cancelEvent
- cancelLatentEvent
- getEventHandlers
- getLatentEventHandles
- getLatentEventStatus
- removeEventHandler
- triggerEvent
- wasEventCancelled