BanPlayer: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 12: Line 12:
{{New feature|3|1.0|
{{New feature|3|1.0|
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
ban banPlayer ( player bannedPlayer, [ bool IP = true, bool Username = false, bool Serial = false, player responsibleElement = nil, string reason = nil ] )
ban banPlayer ( player bannedPlayer, [ bool IP = true, bool Username = false, bool Serial = false, player responsiblePlayer = nil, string reason = nil ] )
</syntaxhighlight>
</syntaxhighlight>
}}
}}
Line 18: Line 18:
{{Deprecated_feature|3|1.0|
{{Deprecated_feature|3|1.0|
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool banPlayer ( player bannedPlayer , [ element responsibleElement , string reason ] )         
bool banPlayer ( player bannedPlayer , [ element responsibleElement, string reason ] )         
</syntaxhighlight>
</syntaxhighlight>
}}
}}
Line 24: Line 24:
===Required Arguments===  
===Required Arguments===  
*'''bannedPlayer:''' The player that will be banned from the server.
*'''bannedPlayer:''' The player that will be banned from the server.
===Optional Arguments===
{{OptionalArg}}
{{New feature|3|1.0|
{{New feature|3|1.0|
*'''IP:''' Will player be banned by IP?
*'''IP:''' Will player be banned by IP?
Line 29: Line 32:
*'''Serial:''' Will player be banned by serial?
*'''Serial:''' Will player be banned by serial?
}}
}}
===Optional Arguments===
{{OptionalArg}}
*'''responsibleElement:''' The element that is responsible for banning the player. This can be a player or the root ([[getRootElement]]()).
*'''responsibleElement:''' The element that is responsible for banning the player. This can be a player or the root ([[getRootElement]]()).
*'''reason:''' The reason the player will be banned from the server.
*'''reason:''' The reason the player will be banned from the server.

Revision as of 11:50, 8 February 2009

This function will ban the specified player by either IP, serial or username

Syntax

ban banPlayer ( player bannedPlayer, [ bool IP = true, bool Username = false, bool Serial = false, player responsiblePlayer = nil, string reason = nil ] )

Required Arguments

  • bannedPlayer: The player that will be banned from the server.

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

  • IP: Will player be banned by IP?
  • Username: Will player be banned by username?
  • Serial: Will player be banned by serial?
  • responsibleElement: The element that is responsible for banning the player. This can be a player or the root (getRootElement()).
  • reason: The reason the player will be banned from the server.

Returns

Returns a ban pointer if banned successfully, or false if unsuccessful.

Example

This example lets a player ban anyone if he has ACL rights. 

--Add the "ban" command handler
-- Example with the player
function banPlayerCommand ( theClient, commandName, bannedName, reason )

	-- Give the player a nice error if he doesn't have rights
	if ( hasObjectPermissionTo ( theClient, "function.banPlayer" ) ) then
		--Get player element from the name
		local bannedPlayer = getPlayerFromNick ( bannedName )

		--Ban the player
		banPlayer ( bannedPlayer, theClient, reason )
		outputChatBox ( "ban: " .. bannedName .. " successfully banned", theClient )

	else
		outputChatBox ( "ban: You don't have enough permissions", theClient )
	end

end
addCommandHandler ( "ban", banPlayerCommand )

-- Example function with the root element. Here you would pass a player element to the function.
function banCheater(theCheater)
	banPlayer(theCheater, getRootElement(), "You are banned because of cheating.")
end

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/BanPlayer?oldid=18347"