OnPlayerBan: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Cancel Effect)
 
Line 13: Line 13:
==Source==
==Source==
The [[event system#Event source|source]] of this event is the [[player]] who was banned.
The [[event system#Event source|source]] of this event is the [[player]] who was banned.
==Cancel effect==
This event cannot be canceled.


==Example==  
==Example==  

Latest revision as of 17:11, 6 December 2023

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.

Cancel effect

This event cannot be canceled.

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 ) ..".", root, 255, 0, 0 ) -- Output the ban.
end
addEventHandler ( "onPlayerBan", root, outputBan ) -- Trigger the function when there is a ban.

Changelog

Version Description
1.3.0-9.03908 Fixed responsible element parameter

See Also

Player events


Event functions

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