NeonBlack: new version of IsYearALeapYear and updated example

2010-07-19T10:38:01Z

new version of IsYearALeapYear and updated example

New page

{{Useful Function}}
__NOTOC__
This function checks if a year is a leap year or not.

==Syntax==
<syntaxhighlight lang="lua">bool isLeapYear( [ int year=getRealTime().year+1900 ] )</syntaxhighlight>

===Optional Arguments===
* '''year''': The year you want to check. Default is your local year.

===Returns===
Returns ''true'' if the year is a leap year, ''false'' otherwise.

==Code==
<section name="Server- and/or clientside Script" class="both" show="true">
<syntaxhighlight lang="lua">
function isLeapYear(year)
if year then year = math.floor(year)
else year = getRealTime().year + 1900 end
return ((year % 4 == 0 and year % 100 ~= 0) or year % 400 == 0)
end
</syntaxhighlight>
</section>

==Example==
<section name="Server" class="server" show="true">
This example tells the player if the given year is a leap year.
<syntaxhighlight lang="lua">
-- define the command handler
addCommandHandler("isYearALeapYear", function (source, cmd, year)
-- check if the player passed a year
year = tonumber(year) or getRealTime().year + 1900
-- check if the given year is a leap year
local leapYear = IsYearALeapYear(year)
--send an answer to the player
if leapYear then
outputChatBox("The year "..year.." is a leap year.", source)
else
outputChatBox("The year "..year.." isn't a leap year.", source)
end
end, false, false)
</syntaxhighlight>
</section>

Author: NeonBlack

==See Also==
{{Useful_Functions}}

IsLeapYear - Revision history

NeonBlack: new version of IsYearALeapYear and updated example