MoonPhase Plugin Help
Sensors:
- Age - The age of the moon.
- NextNewMoon - The date or number of days till the next new moon.
- NextFullMoon - The date or number of days till the next full moon.
- PhaseDescription - The description of the current phase (ie Waxing Crescent).
- MoonDistance - The distance of the moon from the earth (in kilometres).
- SunDistance - The distance of the sun from the earth (in kilometres). A byproduct of the calculations.
- MoonPhase - The percentage of the phase of the moon.
- Illumination - The illumination of the moon.
Parameters:
- DateOrDays: Output the data as a Date or as the number of Days to go (valid input Date or Days). Default is Days.
- DecimalPlaces: The number of decimal places to return. Default is -1 (no rounding at all).
- FormatString: This is dependant of the sensor it is being used on. Default is "%d days, %h hours, %m mins" for Age, "%x %X" for NextNewMoon and NextFullMoon.
- Formatted: Format the string (True) or return it as a number (False). Default is False.
- NumSectors: The total number of sectors (see note below). Default is 10.
- PhaseType: If this is Sectors, the phase is in discrete units, based on the number of sectors. Otherwise, returned as a percentage.
Notes:
Valid formatters for Age are:
%d - Days
%h - Hours
%m - Minutes
%s - Seconds
For NextNewMoon and NextFullMoon they are:
%a
Abbreviated weekday name
%A
Full weekday name
%b
Abbreviated month name
%B
Full month name
%c
Date and time representation appropriate for locale
%d
Day of month as decimal number (01 – 31)
%H
Hour in 24-hour format (00 – 23)
%I
Hour in 12-hour format (01 – 12)
%j
Day of year as decimal number (001 – 366)
%m
Month as decimal number (01 – 12)
%M
Minute as decimal number (00 – 59)
%p
Current locale's A.M./P.M. indicator for 12-hour clock
%S
Second as decimal number (00 – 59)
%U
Week of year as decimal number, with Sunday as first day of week (00 – 53)
%w
Weekday as decimal number (0 – 6; Sunday is 0)
%W
Week of year as decimal number, with Monday as first day of week (00 – 53)
%x
Date representation for current locale
%X
Time representation for current locale
%y
Year without century, as decimal number (00 – 99)
%Y
Year with century, as decimal number
%z, %Z
Either the time-zone name or time zone abbreviation, depending on registry settings; no characters if time zone is unknown
%%
Percent sign
Taken from the MSDN documentation for strftime, as this is directly from there.
MoonDistance and SunDistance are both in kilometres.
The MoonPhase and sectors argument are designed for use with images. If you set PhaseType to "Sectors" and the number of sectors to 8 for example, if the moon in 10% into it's phase, it will return 0, but if it is 90% through, it will return 7. Set the number of sectors to the number of different images for the phase.
Changelog:
1.0.0.1
- Initial public release.