GetBanTime - Revision history

Walid: Added oop syntax

2016-08-06T15:36:48Z

Added oop syntax

2015-11-24T13:25:50Z

← Older revision		Revision as of 13:25, 24 November 2015
Line 9:		Line 9:

	===Required Arguments===		===Required Arguments===
	*'''theBan:''' The [[ban]] in which you wish to retrieve the time of.		*'''theBan:''' The [[ban]] of which you wish to retrieve the time of.

	===Returns===		===Returns===
	* Returns an integer of the banning time in the format of seconds from the year 1970. Use in conjunction with [[getRealTime]] in order to retrieve detailed information.		* Returns an integer of the banning 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 if there was no banning time specified for the [[ban]].		* Returns '''false''' if invalid arguments were specified or if there was no banning time specified for the [[ban]].

	==Example==		==Example==

2013-03-14T13:43:04Z

← Older revision		Revision as of 13:43, 14 March 2013
Line 20:		Line 20:
	local ban = getBanTime(theBan)		local ban = getBanTime(theBan)
	if ban then		if ban then
	outputChatBox("The time of ban is: "..ban, ~~getRootElement()~~, 255,255,255, ~~true~~)		outputChatBox("The time of the ban is: " .. ban, root, 255, 255, 255, false)
	end		end
	end		end

2011-11-12T13:26:00Z

2011-05-03T10:13:00Z

← Older revision		Revision as of 10:13, 3 May 2011
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server function}}		{{Server function}}
	This function will return the ~~banning~~ time of the specified [[ban]] ~~pointer~~ in '''seconds'''.		This function will return the time the specified [[ban]] was created, in '''seconds'''.

	==Syntax==		==Syntax==

2011-05-03T08:59:24Z

Learn to indent and create examples that actually use a function correctly.

← Older revision		Revision as of 08:59, 3 May 2011
Line 18:		Line 18:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function retrieveBan(theBan)		function retrieveBan(theBan)
	local ban = getBanTime(theBan)		local ban = getBanTime(theBan)
	if ban then		if ban then
	outputChatBox("The ~~following~~ ban ~~duration~~ is: "..ban, getRootElement(), 255,255,255, true)		outputChatBox("The time of ban is: "..ban, getRootElement(), 255,255,255, true)
	end		end
	end		end
	</syntaxhighlight>		</syntaxhighlight>

2011-05-02T20:13:16Z

← Older revision		Revision as of 20:13, 2 May 2011
Line 17:		Line 17:
	==Example==		==Example==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~--TODO~~		function retrieveBan(theBan)
			local ban = getBanTime(theBan)
			if ban then
			outputChatBox("The following ban duration is: "..ban, getRootElement(), 255,255,255, true)
			end
			end
	</syntaxhighlight>		</syntaxhighlight>

2009-07-09T19:05:42Z

2009-06-18T17:52:12Z

Needs example

2009-02-13T21:10:58Z

← Older revision		Revision as of 21:10, 13 February 2009
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server function}}		{{Server function}}
	This function will return the banning time of the specified [[ban]] pointer.		This function will return the banning time of the specified [[ban]] pointer in '''seconds'''.

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~string~~ getBanTime ( ban theBan )		int getBanTime ( ban theBan )
	</syntaxhighlight>		</syntaxhighlight>

Line 12:		Line 12:

	===Returns===		===Returns===
	* Returns ~~a string~~ of the banning time in the format of ~~'''HH:MM:SS''' (Hours, minutes,~~ seconds ~~correspondingly)~~		* Returns an integer of the banning 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 if there was no banning time specified for the [[ban]].		* Returns '''false''' if invalid arguments are specified if there was no banning time specified for the [[ban]].