GetUnbanTime: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(New page: __NOTOC__ {{Server function}} This function will return the unbanning time of the specified ban pointer in '''seconds'''. ==Syntax== <syntaxhighlight lang="lua"> int getUnbanTime ( ban theBan ) </...)
 
m (fix oop)
 
(8 intermediate revisions by 7 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Server function}}
{{Server function}}
This function will return the unbanning time of the specified [[ban]] pointer in '''seconds'''.
This function will return the unbanning time of the specified [[ban]] in '''seconds'''.


==Syntax==  
==Syntax==  
Line 7: Line 7:
int getUnbanTime ( ban theBan )
int getUnbanTime ( ban theBan )
</syntaxhighlight>
</syntaxhighlight>
{{OOP||[[ban]]:getUnbanTime|unbanTime|setUnbanTime}}


===Required Arguments===  
===Required Arguments===  
Line 17: Line 19:
==Example==
==Example==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--TODO
function listBans ()
local bansList = getBans() -- Return a table of all the bans.
for banID, ban in ipairs ( banList ) do -- For every ban do the following...
local nick = getBanNick ( ban ) -- Get the IP of the ban
                local timetounban = getUnbanTime ( ban ) -- get the time to wait of the banned player
if nick then
outputChatBox ( "Ban #" .. banID .. ": " .. nick.." || Time to unban: "..timetounban , source, 255, 0, 0 ) -- Output the baninfo
end
end
end
addCommandHandler ( "bans", listBans ) -- Add "/bans" as the trigger for the function.
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{Admin functions}}
{{Admin functions}}
[[ru:getUnbanTime]]

Latest revision as of 14:39, 7 August 2016

This function will return the unbanning time of the specified ban in seconds.

Syntax

int getUnbanTime ( ban theBan )


OOP Syntax Help! I don't understand this!

Method: ban:getUnbanTime(...)
Variable: .unbanTime
Counterpart: setUnbanTime


Required Arguments

  • theBan: The ban in which you wish to retrieve the unban time of.

Returns

  • Returns an integer of the unbanning time in the format of seconds from the year 1970. Use in conjunction with getRealTime in order to retrieve detailed information.
  • Returns false if invalid arguments are specified or if there was no unbanning time specified for the ban.

Example

function listBans ()
	local bansList = getBans() -- Return a table of all the bans.
 
	for banID, ban in ipairs ( banList ) do -- For every ban do the following...
		local nick = getBanNick ( ban ) -- Get the IP of the ban
                local timetounban = getUnbanTime ( ban ) -- get the time to wait of the banned player
		if nick then
			outputChatBox ( "Ban #" .. banID .. ": " .. nick.." || Time to unban: "..timetounban , source, 255, 0, 0 ) -- Output the baninfo
		end
	end
end
addCommandHandler ( "bans", listBans ) -- Add "/bans" as the trigger for the function.

See Also