OnBan: Difference between revisions
Jump to navigation
Jump to search
m (Improving) |
Tag: Rollback |
||
| (13 intermediate revisions by 6 users not shown) | |||
| Line 8: | Line 8: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
*'''theBan ''': | *'''theBan''': the [[ban]] which was added. | ||
==Source== | ==Source== | ||
| Line 14: | Line 14: | ||
==Cancel effect== | ==Cancel effect== | ||
This event cannot be canceled. | |||
==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 ) | ||
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 | 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 | |||
</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
- addEvent
- addEventHandler
- cancelEvent
- cancelLatentEvent
- getEventHandlers
- getLatentEventHandles
- getLatentEventStatus
- removeEventHandler
- triggerEvent
- wasEventCancelled