GetBanIP: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(Added oop syntax)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Server function}}
{{Server function}}
This function will return the IP of the specified [[ban]] pointer.
This function will return the IP of the specified [[ban]].


==Syntax==  
==Syntax==  
Line 7: Line 7:
string getBanIP ( ban theBan )
string getBanIP ( ban theBan )
</syntaxhighlight>
</syntaxhighlight>
{{OOP||[[ban]]:getIP|ip|}}


===Required Arguments===  
===Required Arguments===  
Line 15: Line 17:


==Example==
==Example==
This example will  
This example will show the user who banned a player the IP adress of that banned player.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function banPlayerCommand ( thisPlayer, commandName, bannedName, reason )
function banPlayerCommand ( thisPlayer, commandName, bannedName, reason )

Latest revision as of 15:20, 6 August 2016

This function will return the IP of the specified ban.

Syntax

string getBanIP ( ban theBan )


OOP Syntax Help! I don't understand this!

Method: ban:getIP(...)
Variable: .ip


Required Arguments

  • theBan: The ban in which you want to return the IP of.

Returns

Returns a string of the IP if everything was successful, false if invalid arguments are specified if there was no IP specified for the ban.

Example

This example will show the user who banned a player the IP adress of that banned player.

function banPlayerCommand ( thisPlayer, commandName, bannedName, reason )
    if ( hasObjectPermissionTo ( thisPlayer, "function.banPlayer" ) ) then -- If the command user has the rights
        local bannedPlayer = getPlayerFromNick ( bannedName ) -- Get the ID from the player who gets banned
        if getElementType ( bannedPlayer ) == "player" then -- If it's a player
            local theBan = banPlayer ( bannedPlayer, thisPlayer, reason ) -- Ban the player
            outputChatBox ( "ban: " .. bannedName .. " successfully banned", thisPlayer ) -- Send the banner a succes message
            outputChatBox ( "At IP Adress: " ..getBanIP ( theBan ), thisPlayer ) -- And send him the IP adress of the banned player
        end
    else
        outputChatBox ( "ban: You don't have enough permissions", thisPlayer ) -- If the command user doesn't have the permissions
    end
end
addCommandHandler ( "ban", banPlayerCommand )

See Also