Difference between revisions of "BanSerial"

From Multi Theft Auto: Wiki
Line 2: Line 2:
 
{{Server function}}
 
{{Server function}}
 
{{Deprecated}}
 
{{Deprecated}}
This function will ban the specified serial number from the server.
+
This function will ban the specified [[serial]] number from the server.
  
 
==Syntax==  
 
==Syntax==  

Revision as of 07:12, 13 April 2009

Emblem-important.png This function is deprecated. This means that its use is discouraged and that it might not exist in future versions, but there should be a more generic way to perform what it does.

This function will ban the specified serial number from the server.

Syntax

bool banSerial ( string theSerial )         

Required Arguments

  • theSerial: The serial to ban from this server

Returns

Returns true if the serial was banned succesfully, false if invalid arguments are specified.

Example

This example lets a client (console or player) ban a serial if he has ACL rights.

--Add the "banserial" command handler
function banSerialCommand ( theClient, commandName, bannedSerial )

	-- Give the player a nice error if he doesn't have rights
	if ( hasObjectPermissionTo ( theClient, "function.banSerial" ) ) 

		--Ban the serial
		banSerial ( bannedSerial )
		outputChatBox ( "banserial: Serial " .. bannedSerial .. " successfully banned", theClient )
	else
		outputChatBox ( "banserial: You don't have enough permissions", theClient )
	end

end
addCommandHandler ( "banserial", banSerialCommand )

See Also