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'...) |
No edit summary |
||
| (15 intermediate revisions by 7 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server event}} | {{Server event}} | ||
This event is triggered when | This event is triggered when a ban is removed from the server. | ||
if the ban was removed using function [[removeBan]], and the responsibleElement was not specifying, the event will return nil. | |||
==Parameters== | ==Parameters== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
ban theBan, player responsibleElement | |||
</syntaxhighlight> | </syntaxhighlight> | ||
*''' | *'''theBan ''': the [[ban]] that will be removed. | ||
*'''responsibleElement''': the [[player]] who removed the ban, otherwise returns ''nil''. | |||
==Source== | ==Source== | ||
The | The source is always the global root element. | ||
==Cancel effect== | ==Cancel effect== | ||
| Line 21: | Line 24: | ||
<!-- 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( theBan, responsibleElement ) | ||
if getElementType( responsibleElement ) then --Check if a player unbanned the IP/Serial | |||
outputChatBox( getPlayerName( responsibleElement ) .. " unbanned " .. ( getBanSerial(theBan) or getBanIP(theBan) ) ) --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> | ||
== | ==Changelog== | ||
{{ | {{ChangelogHeader}} | ||
{{ChangelogItem|1.3.0-9.03908|Fixed/added responsible element parameter}} | |||
{{See also/Server event|Server events}} | |||
Latest revision as of 03:05, 27 September 2018
This event is triggered when a ban is removed from the server.
if the ban was removed using function removeBan, and the responsibleElement was not specifying, the event will return nil.
Parameters
ban theBan, player responsibleElement
- theBan : the ban that will be removed.
- responsibleElement: the player who removed the ban, otherwise returns nil.
Source
The source is always 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( theBan, responsibleElement ) if getElementType( responsibleElement ) then --Check if a player unbanned the IP/Serial outputChatBox( getPlayerName( responsibleElement ) .. " unbanned " .. ( getBanSerial(theBan) or getBanIP(theBan) ) ) --Output to the chatbox saying the player has unbanned the IP/Serial end end addEventHandler( "onUnban", root, announceUnban ) --Adds the event handler for 'onUnban'
Changelog
| Version | Description |
|---|
| 1.3.0-9.03908 | Fixed/added responsible element parameter |
See Also
Server events
Event functions
- addEvent
- addEventHandler
- cancelEvent
- cancelLatentEvent
- getEventHandlers
- getLatentEventHandles
- getLatentEventStatus
- removeEventHandler
- triggerEvent
- wasEventCancelled