OnPlayerBan: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Added an example.)
No edit summary
Line 12: Line 12:


==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 [[player]] who was banned.


==Example==  
==Example==  
This example outputs the responcible element and the ban pointer when a ban takes place.
This example outputs the responsible element and the banned player's name when a ban takes place.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function outputBan ( banPointer, responcibleElement ) -- Define the banner and the ban pointer in the function.
function outputBan ( banPointer, responsibleElement ) -- Define the banner and the ban pointer in the function.
outputChatBox ( getPlayerName(responcibleElement ).." has banned ".. banPointer ..".", getRootElement(), 255, 0, 0 ) -- Output the ban.
local banner = getPlayerName( responsibleElement ) or "Console" -- Get the banner's name.
outputChatBox ( banner .." has banned ".. getPlayerName( source ) ..".", getRootElement(), 255, 0, 0 ) -- Output the ban.
end
end
addEventHandler ( "onPlayerBan", getRootElement(), outputBan ) -- Trigger the function when there is a ban.
addEventHandler ( "onPlayerBan", getRootElement(), outputBan ) -- Trigger the function when there is a ban.

Revision as of 16:17, 25 February 2010

This event is triggered when a player added a ban (like onBan).

Parameters

ban banPointer, player responsibleElement
  • banPointer: The ban pointer which was added.
  • responsibleElement: The player who added the ban

Source

The source of this event is the player who was banned.

Example

This example outputs the responsible element and the banned player's name when a ban takes place. 

function outputBan ( banPointer, responsibleElement ) -- Define the banner and the ban pointer in the function.
	local banner = getPlayerName( responsibleElement ) or "Console" -- Get the banner's name.
	
	outputChatBox ( banner .." has banned ".. getPlayerName( source ) ..".", getRootElement(), 255, 0, 0 ) -- Output the ban.
end
addEventHandler ( "onPlayerBan", getRootElement(), outputBan ) -- Trigger the function when there is a ban.

See Also

Player events


Event functions


Retrieved from "https://wiki.multitheftauto.com/wiki/OnPlayerBan?oldid=22484"