BanPlayer: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 5: Line 5:
}}
}}


{{Deprecated_feature|3|1.0|
This function will ban the specified player from the server by IP.
This function will ban the specified player from the server by IP.
}}


==Syntax==  
==Syntax==  
Line 14: Line 16:
}}
}}


{{Deprecated_feature|3|1.0|
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool banPlayer ( player bannedPlayer , [ element responsibleElement , string reason ] )         
ban banPlayer ( player bannedPlayer , [ element responsibleElement , string reason ] )         
</syntaxhighlight>
</syntaxhighlight>
}}


===Required Arguments===  
===Required Arguments===  
Line 32: Line 36:


===Returns===
===Returns===
{{Deprecated_feature|3|1.0|
Returns ''true'' if the player was banned succesfully, ''false'' if invalid arguments are specified.
Returns ''true'' if the player was banned succesfully, ''false'' if invalid arguments are specified.
}}
{{New feature|3|1.0|
Returns a [[ban]] pointer if banned successfully, or ''false'' if unsuccessful.
}}


==Example==
==Example==

Revision as of 17:42, 23 January 2009

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

Syntax

bool banPlayer ( player bannedPlayer, bool IP, bool Username, bool Serial, [ player responsibleElement, string reason ] )

Required Arguments

  • bannedPlayer: The player that will be banned from the server.
  • IP: Will player be banned by IP?
  • Username: Will player be banned by username?
  • Serial: Will player be banned by serial?

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.

  • 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=18255"