view release on metacpan or  search on metacpan

docs/Acme-FishFarm-Feeder-1.01.html  view on Meta::CPAN

<h2 id="set_timer-time">set_timer ( $time )</h2>

<p>Sets the new timer threshold of the feeder.</p>

<p>Setting this timer will not affect the clock within the feeder.</p>

<h2 id="timer_is_up">timer_is_up</h2>

<p>Check if the timer is up. If timer is up, please remember to feed your fish. See <code>feed_fish</code> for more info.</p>

<h2 id="time_remaining">time_remaining</h2>

<p>Returns the time remaining to feed the fish.</p>

<p>This method might not be really useful, but anyway :)</p>

<h2 id="tick_clock-custom_tick">tick_clock ( $custom_tick )</h2>

<p><code>$custom_tick</code> is optional and the default is <code>1</code>.</p>

<p>This will cause the timer of the feeder to increase by <code>1</code> (default) or by <code>$custom_tick</code>.</p>

<h1 id="FOOD-TANK-RELATED-SUBROUTINE-METHODS">FOOD TANK RELATED SUBROUTINE/METHODS</h1>

<h2 id="food_tank_capacity">food_tank_capacity</h2>

<p>Returns the current food tank capacity.</p>

<h2 id="set_food_tank_capacity-new_capacity">set_food_tank_capacity ( $new_capacity )</h2>

<p>Set the new food tank capacity to <code>$new_capacity</code>.</p>

<h2 id="food_remaining">food_remaining</h2>

<p>Returns the remaining amount of food left.</p>

<h1 id="FEEDING-RELATED-SUBROUTINES-METHODS">FEEDING RELATED SUBROUTINES/METHODS</h1>

<h2 id="feed_fish-options">feed_fish ( %options )</h2>

<p>Feeds the fish.</p>

<p>Take note that this will feed the fish no matter what. So it&#39;s up to you to make sure that you check if the feeder timer is really up or not before calling this method. See <code>timer_is_up</code> for more info.</p>

<p><code>%options</code> supports the following key:</p>

<ul>

<li><p>verbose</p>

<p>Setting this to a true value will give output about the feeder&#39;s situation when feeding the fish.</p>

</li>
</ul>

<h2 id="set_feeding_volume-volume">set_feeding_volume ( $volume )</h2>

<p>Sets the fish food feeding volume.</p>

<p><code>$volume</code> must be a positive number. No error checking is done for this yet.</p>

<h2 id="feeding_volume">feeding_volume</h2>

<p>Returns the amount of food to feed the fish each time the <code>feed_fish</code> method is called.</p>

<h2 id="refill-volume">refill ( $volume )</h2>

<p>Refills the fish food tank <b>TO</b> <code>$volume</code>.</p>

<p>If <code>$volume</code> is not specified, the food tank will be filled to max.</p>

<p>If <code>$volume</code> is a strange value, it will be ignored and filled to max.</p>

<h1 id="AUTHOR">AUTHOR</h1>

<p>Raphael Jong Jun Jie, <code>&lt;ellednera at cpan.org&gt;</code></p>

<h1 id="BUGS">BUGS</h1>

<p>Please report any bugs or feature requests to <code>bug-. at rt.cpan.org</code>, or through the web interface at <a href="https://rt.cpan.org/NoAuth/ReportBug.html?Queue=.">https://rt.cpan.org/NoAuth/ReportBug.html?Queue=.</a>. I will be notified,...

<h1 id="SUPPORT">SUPPORT</h1>

<p>You can find documentation for this module with the perldoc command.</p>

<pre><code>    perldoc Acme::FishFarm::Feeder</code></pre>

<p>You can also look for information at:</p>

<ul>

<li><p>RT: CPAN&#39;s request tracker (report bugs here)</p>

<p><a href="https://rt.cpan.org/NoAuth/Bugs.html?Dist=.">https://rt.cpan.org/NoAuth/Bugs.html?Dist=.</a></p>

</li>
<li><p>CPAN Ratings</p>

<p><a href="https://cpanratings.perl.org/d/.">https://cpanratings.perl.org/d/.</a></p>

</li>
<li><p>Search CPAN</p>

<p><a href="https://metacpan.org/release/.">https://metacpan.org/release/.</a></p>

</li>
</ul>

<h1 id="ACKNOWLEDGEMENTS">ACKNOWLEDGEMENTS</h1>

<p>Besiyata d&#39;shmaya</p>

<h1 id="SEE-ALSO">SEE ALSO</h1>

<pre><code>    Acme::FishFarm</code></pre>

<h1 id="LICENSE-AND-COPYRIGHT">LICENSE AND COPYRIGHT</h1>

<p>This software is Copyright (c) 2021 by Raphael Jong Jun Jie.</p>