OnUnban: Difference between revisions
Jump to navigation
Jump to search
(New page: __NOTOC__ {{Server event}} This event is triggered when an IP address or serial is unbanned from the server. ==Parameters== <syntaxhighlight lang="lua"> string theIPOrSerial </syntaxhighlight> *'''theIPOrSerial'...) |
(Added an example) |
||
| Line 21: | Line 21: | ||
<!-- 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 --> | <!-- 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"> | ||
-- | root = getRootElement() | ||
-- | function announceUnban( sz ) | ||
if getElementType( source ) then --Check if a player unbanned the IP/Serial | |||
outputChatBox( getClientName( source ) .. " unbanned " .. sz ) --Output to the chatbox saying the player has unbanned the IP/Serial | |||
end | |||
end | |||
addEventHandler( "onUnban", root, announceUnban ) --Adds the event handler for 'onUnban' | |||
</syntaxhighlight> | </syntaxhighlight> | ||
Revision as of 00:30, 7 January 2008
This event is triggered when an IP address or serial is unbanned from the server.
Parameters
string theIPOrSerial
- theIPOrSerial: The IP address or serial that was unbanned from the server.
Source
The source of this event is the element that was responsible for the unbanning. If no responsible was specified, the source is the global root element.
Cancel effect
If this event is canceled, the requested unban is not performed.
Example
This example does...
root = getRootElement() function announceUnban( sz ) if getElementType( source ) then --Check if a player unbanned the IP/Serial outputChatBox( getClientName( source ) .. " unbanned " .. sz ) --Output to the chatbox saying the player has unbanned the IP/Serial end end addEventHandler( "onUnban", root, announceUnban ) --Adds the event handler for 'onUnban'