====== Leaky Ring Javascript Docs ======
<note important>This is not a guide to use [[Leaky Ring]]. This is a documentation on for customizing Leaky Ring.</note>

<WRAP center round todo 60%>
Under Construction
</WRAP>

===== Style =====
==== flood.info ====
<code>flood.info</code>
Default: <code>&#x1FAA3;</code>

Description: The emoji of the icon on the bottom right.

==== flood.drainSound ====
<code> flood.drainSound </code>
Default: ''"https://melonking.net/audio/ui/flush.mp3"''

Description: Sound when you bilge the flood.

==== flood.drainTooSoonSound ====
<code>flood.drainTooSoonSound</code>
Default: ''"https://melonking.net/audio/ui/clunk.mp3"''

Description: Sound when you bilge the flood too soon.

==== flood.includeInfo ====
<code>flood.includeInfo</code>
Default: ''false''

Description: Returns a list of all sites who are flooded.

==== flood.msg.rising ====
<code>flood.msg.rising</code>
Default: ''The water level is rising...''

==== flood.msg.falling ====
<code>flood.msg.falling</code>
Default: ''The water level is falling...''

==== flood.disableInFrames ====
<code>flood.disableInFrames</code>
Default: ''false''

Description: Stop the script running in frames

===== Messages =====
==== disableMessages ====
<code>disableMessages</code>
Default: ''false''

Description: Hides the info message.

==== flood.msg.toosoon ====
<code>flood.msg.toosoon</code>
Default: ''"Its too soon to bilge again!..."''

==== flood.msg.one ====
<code>flood.msg.one</code>
Default: ''"This page has a harmless leak."''

==== flood.msg.two ====
<code>flood.msg.two</code>
Default: ''"It looks like the page has a bad leak!"''

==== flood.msg.three ====
<code>flood.msg.three</code>
Default: ''"Goodness, this page has a major leak!"''

==== flood.msg.four ====
<code>flood.msg.four</code>
Default: ''"Oh my, there's flood on this page!"''

==== flood.msg.five ====
<code>flood.msg.five</code>
Default: ''"The page is deep under water!"''

==== flood.msg.six ====
<code>flood.msg.six</code>

Default: ''"This page is totaly submerged!"''

===== The Flood =====
==== flood.updateSpeed ====
<note tip>Do not change it to anything lower then 5000.</note>

<code>flood.updateSpeed</code>

Default: ''5000''

Description: The update speed for the draining/filling animation.

==== flood.renderSpeed ====

<code>flood.renderSpeed</code>

Default: ''70''

==== flood.maxLevel ====
<note tip>Please don't edit this!</note>

<code> flood.maxLevel </code>

Default: ''100''

Description: Limit amount of percentage in a flood. 

==== flood.bilgeDelay ====
<note tip>Please don't edit this! That's cheating!! </note>

<code> flood.bilgeDelay </code>

Default: ''10000''

Description: Cooldown for how much water

==== flood.level ====
<code>flood.level</code>

Default: ''0''

Description: The percentage of the flood.

===== Server/Maintenance =====
==== flood.serverURL ====
<note tip>Do not edit this, Unless you wanna self-host your own leaky ring server</note>
<code>flood.serverURL</code>

Default: ''https://brain.melonking.net''

Description: Used to get the leaky ring data. 

==== flood.ringPage ====

<note tip>Please do not remove this! For giving credit to melon only, this link leads back to his page all about the leaky ring! :^[</note>
<code>flood.ringPage</code>

Default: ''https://melonking.net/free/software/flood.html''

Description: For leading back to the original source of the leaky ring. (By clicking on the bucket)

==== flood.ringTarget ====

<code>flood.serverURL</code>

Default: ''_blank''

==== flood.updateLoop ====

<code>flood.updateLoop</code>

Default: ''undefined''

==== flood.renderLoop ====

<code>flood.renderLoop</code>

Default: ''undefined''

==== flood.lastBilge ====

<code>flood.lastBilge</code>

Default: ''0''

Description: Tells you your last pages bilge. 

==== flood.logicLevel ====
<code>flood.logicLevel</code>

Default: ''0''

==== flood.changeStep ====
<code>flood.changeStep</code>

Default: ''0''