Skip to content

Latest commit

 

History

History
21 lines (12 loc) · 1022 Bytes

search-lunar-eclipse.md

File metadata and controls

21 lines (12 loc) · 1022 Bytes

//astronomy/io.github.cosinekitty.astronomy/searchLunarEclipse

searchLunarEclipse

fun searchLunarEclipse(startTime: Time): LunarEclipseInfo

Searches for a lunar eclipse.

This function finds the first lunar eclipse that occurs after startTime. A lunar eclipse may be penumbral, partial, or total. See LunarEclipseInfo for more information. To find a series of lunar eclipses, call this function once, then keep calling nextLunarEclipse as many times as desired, passing in the center value returned from the previous call.

See lunarEclipsesAfter for convenient iteration of consecutive lunar eclipses.

Return

Information about the first lunar eclipse that occurs after startTime.

Parameters

startTime The date and time for starting the search for a lunar eclipse.