Difference between revisions of "Stat bonus today"

Latest revision as of 21:37, 21 May 2010

stat stat_bonus_today()

Returns the stat that is benefited by the moon phases today. If it is an "ordinary" day (no stat benefits), the return value is $stat[none].

This example attempts to eat some food giving moxie substats if today is a moxie day.

if(stat_bonus_today() == $stat[moxie]) {
   eat(3 , $item[rat appendix chow mein]);
}

When not logged in, this function returns $stat[none](needs spading).

@@ Line 1: / Line 1: @@
-'''stat stat_bonus_today()'''<br/>
+{{
-Returns the stat that is benefitted by the moon phases today. If it is an “ordinary” day, the return value is $stat[none].
+#vardefine:name|stat_bonus_today}}{{
-[[Category:Your Character | Stat bonus today()]]
+#vardefine:return_type|stat}}{{
-[[Category:Ash Functions |Stat bonus today()]]
+FunctionPage|
+name={{#var:name}}|
+function1={{Function|
+name={{#var:name}}|
+aggregate={{#var:aggregate}}|
+return_type={{#var:return_type}}|
+return_also={{#var:return_also}}
+}}|
+function_description=Returns the stat that is benefited by the moon phases today.  If it is an "ordinary" day (no stat benefits), the return value is $stat[none].|
+code1={{CodeSample|
+title=Code Samples|
+description=This example attempts to eat some food giving moxie substats if today is a moxie day.|
+code=
+<syntaxhighlight>
+if(stat_bonus_today() == $stat[moxie]) {
+   eat(3 , $item[rat appendix chow mein]);
+}
+</syntaxhighlight>
+}}|
+see_also={{SeeAlso|stat_bonus_tomorrow|my_primestat}}|
+special=When not logged in, this function returns $stat[none](needs spading).
+}}
+[[Category:Your Character]]